plone.app.fhirfield 1.0.0b4

Background (plone.app.fhirfield)

FHIR (Fast Healthcare Interoperability Resources) is the industry standard for Healthcare system. Our intend to implement FHIR based system using Plone! plone.app.fhirfield will make life easier to create, manage content for FHIR resources.

from plone.app.fhirfield import FhirResource
from plone.supermodel import model

class IMyContent(model.Schema):

    resource = FhirResource(
        title=u'your title',
        desciption=u'your desciption',
        resource_type='any fhir resource type[optional]'
    )

Available Field’s Options

This field has got all standard options (i.e title, required, desciption and so on) with additionally options for the purpose of either validation or constraint those are related to FHIR.

resource_type

Required: No

Default: None

Type: String

The name of FHIR resource can be used as constraint, meaning that we can restricted only accept certain resource. If FHIR json is provided that contains other resource type, would raise validation error. Example: FhirResource(….,resource_type=’Patient’)

model

Required: No

Default: None

Type: String + full python path (dotted) of the model class.

Like resource_type option, it can be used as constraint, however additionally this option enable us to use custom model class other than fhirclient’s model. Example: FhirResource(….,model=’fhirclient.models.patient.Patient’)

model_interface

Required: No

Default: None

Type: String + full python path (dotted) of the model class.

Unlike model option, this option has more versatile goal although you can use it for single resource restriction. The advanced usecase like, the field could accept muiltiple resources types those model class implements the provided interface. For example you made a interface called IMedicalService and (Organization, Patient, Practitioner) models those are implementing IMedicalService. So when you provides this option value, actually three types of fhir json can now be accepted by this field. Example: FhirResource(….,model=’plone.app.interfaces.IFhirResourceModel’)

Field’s Value API

Field’s value is a specilized class plone.app.fhirfield.value.FhirResourceValue which has reponsibilty to act as proxy of fhirclient model’s class. This class provides some powerful methods.

FhirResourceValue::as_json

Originally this method is derived from fhirclient base model, you will always have to use this method during negotiation (although our serializer doing that for you automatically). This method not takes any argument, it returns FHIR json representation of resource.

FhirResourceValue::patch

If you are familar with FHIRPath Patch, this method one of the strongest weapon of this class. Patch applying on any FHIR resources is noting but so easy. This method takes one mandatory argument patch_data and that value should be list of patch items (jsonpatch).

Example:

from plone.app.fhirfield import FhirResource
from plone.supermodel import model

class ITask(model.Schema):

    resource = FhirResource(
        title=u'your title',
        desciption=u'your desciption',
        resource_type='Task'
    )

patch_data = [
  {'op': 'replace', 'path': '/source/display', 'value': 'Patched display'},
  {'op': 'replace', 'path': '/status', 'value': 'Reopen'}
]
task_content.resource.patch(patch_data)

FhirResourceValue::stringify

This method returns string representation of fhir resource json value. Normally as_json returns python’s dict type data. This method takes optional prettify argument, by setting this argument True, method will return human/print friendly representation.

FhirResourceValue::foreground_origin

There may some situation come, where you will need just pure instance of fhir model, this method serves that purpose. This method returns current fhir resource model’s instance.

Example:

from fhirclient.models.task import Task
from plone.app.fhirfield import FhirResource
from plone.supermodel import model

class ITask(model.Schema):

    resource = FhirResource(
        title=u'your title',
        desciption=u'your desciption',
        resource_type='Task'
    )

task = task_content.resource.foreground_origin()
assert isinstance(task, Task)

Helper API

This package provides some useful functions those could be usable in your codebase.

resource_type_str_to_fhir_model

This function return appropriate fhirclient model class based on provided resource type. On wrong resource type zope.interface.Invalid exception is raisen.

Example:

>>> from plone.app.fhirfield.helpers import resource_type_str_to_fhir_model
>>> task_model_class = resource_type_str_to_fhir_model('Task')

Available Catalog PluginIndexes

Bellows are fhirfield based catalog indexes are available.

1. FhirActivityDefinitionIndex

   • Resource Type: ActivityDefinition

   • Has Mapping: yes

2. FhirAppointmentIndex

   • Resource Type: Appointment

   • Has Mapping: yes

3. FhirCarePlanIndex

   • Resource Type: CarePlan

   • Has Mapping: yes

4. FhirDeviceIndex

   • Resource Type: Device

   • Has Mapping: yes

5. FhirDeviceRequestIndex

   • Resource Type: DeviceRequest

   • Has Mapping: yes

6. FhirHealthcareServiceIndex

   • Resource Type: HealthcareService

   • Has Mapping: yes

7. FhirMedicationAdministrationIndex

   • Resource Type: MedicationAdministration

   • Has Mapping: yes

8. FhirMedicationDispenseIndex

   • Resource Type: MedicationDispense

   • Has Mapping: yes

9. FhirMedicationRequestIndex

   • Resource Type: MedicationRequest

   • Has Mapping: yes

10. FhirMedicationStatementIndex

    • Resource Type: MedicationStatement

    • Has Mapping: yes

11. FhirObservationIndex

    • Resource Type: Observation

    • Has Mapping: yes

12. FhirOrganizationIndex

    • Resource Type: Organization

    • Has Mapping: yes

13. FhirPatientIndex

    • Resource Type: Patient

    • Has Mapping: yes

14. FhirPlanDefinitionIndex

    • Resource Type: PlanDefinition

    • Has Mapping: yes

15. FhirPractitionerIndex

    • Resource Type: Practitioner

    • Has Mapping: yes

16. FhirProcedureRequestIndex

    • Resource Type: ProcedureRequest

    • Has Mapping: yes

17. FhirQuestionnaireIndex

    • Resource Type: Questionnaire

    • Has Mapping: yes

18. FhirQuestionnaireResponseIndex

    • Resource Type: QuestionnaireResponse

    • Has Mapping: yes

19. FhirRelatedPersonIndex

    • Resource Type: RelatedPerson

    • Has Mapping: yes

20. FhirTaskIndex

    • Resource Type: Task

    • Has Mapping: yes

21. FhirValueSetIndex

    • Resource Type: ValueSet

    • Has Mapping: yes

22. FhirFieldIndex:

    • Resource Type: any valid fhir resource

    • Has Mapping: minimal (id, identifier, meta)

Example usages:

<?xml version="1.0"?>
<object name="portal_catalog" meta_type="Plone Catalog Tool">
    <index name="organization_resource" meta_type="FhirOrganizationIndex">
        <indexed_attr value="organization_resource"/>
    </index>
</object>

elasticsearch setup

If your intent to use elasticsearch based indexing and query, this section for you! you can find more details here

Installation

Install plone.app.fhirfield by adding it to your buildout:

[buildout]

...

eggs =
    plone.app.fhirfield [elasticsearch]

and then running bin/buildout

Links

Code repository:

https://github.com/nazrulworld/plone.app.fhirfield

Continuous Integration:

https://travis-ci.org/nazrulworld/plone.app.fhirfield

Issue Tracker:

https://github.com/nazrulworld/plone.app.fhirfield/issues

Contributors

• Md Nazrul Islam (Author), email2nazrul@gmail.com

Changelog