fhir-eswatini@0.3.0
This adaptor exports the following namespaced functions:
- builders.appointment(props)
- builders.condition(props)
- builders.encounter(props)
- builders.episodeOfCare(props)
- builders.location(props)
- builders.medication(props)
- builders.medicationDispense(props)
- builders.medicationRequest(props)
- builders.observation(type, props)
- builders.organization(props)
- builders.patient(props)
- builders.practitioner(props)
- builders.procedure(props)
- builders.serviceRequest(type, props)
- builders.specimen(props)
builders
These functions belong to the builders namespace.
builders.appointment
appointment(props)
Create a Appointment resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | External Ids for this item |
| [props.status] | string | proposed |
| [props.cancelationReason] | string | The coded reason for the appointment being cancelled. Accepts all values from http://hl7.org/fhir/ValueSet/appointment-cancellation-reason |
| [props.serviceCategory] | string | A broad categorization of the service that is to be performed during this appointment. Accepts all values from http://hl7.org/fhir/ValueSet/service-category |
| [props.serviceType] | string | The specific service that is to be performed during this appointment. Accepts all values from http://hl7.org/fhir/ValueSet/service-type |
| [props.specialty] | string | The specialty of a practitioner that would be required to perform the service requested in this appointment. Accepts all values from http://hl7.org/fhir/ValueSet/c80-practice-codes |
| [props.appointmentType] | string | The style of appointment or patient that has been booked in the slot (not service type). Accepts all values from http://terminology.hl7.org/ValueSet/v2-0276 |
| [props.reasonCode] | string | Coded reason this appointment is scheduled. Accepts all values from http://hl7.org/fhir/ValueSet/encounter-reason |
| [props.reasonReference] | Reference | Reason the appointment is to take place (resource) |
| [props.priority] | unsignedInt | Used to make informed decisions if needing to re-prioritize |
| [props.description] | string | Shown on a subject line in a meeting request, or appointment list |
| [props.supportingInformation] | Reference | Additional information to support the appointment |
| [props.start] | instant | When appointment is to take place |
| [props.end] | instant | When appointment is to conclude |
| [props.minutesDuration] | number | Can be less than start/end (e.g. estimate) |
| [props.slot] | Reference | The slots that this appointment is filling |
| [props.created] | dateTime | The date that this appointment was initially created |
| [props.comment] | string | Additional comments |
| [props.patientInstruction] | string | Detailed information and instructions for the patient |
| [props.basedOn] | Reference | The service request this appointment is allocated to assess |
| [props.participant] | BackboneElement | Participants involved in appointment |
| [props.requestedPeriod] | Period | Potential date/time interval(s) requested to allocate the appointment within |
builders.condition
condition(props)
Create a Condition resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | External Ids for this condition |
| [props.clinicalStatus] | string | active |
| [props.verificationStatus] | string | unconfirmed |
| [props.category] | string | problem-list-item |
| [props.severity] | string | Subjective severity of condition. Accepts all values from http://hl7.org/fhir/ValueSet/condition-severity |
| [props.code] | string | Condition Identification. Accepts all values from http://hl7.org/fhir/ValueSet/condition-code |
| [props.bodySite] | string | Anatomical location, if relevant. Accepts all values from http://hl7.org/fhir/ValueSet/body-site |
| [props.subject] | Reference | Who has the condition? |
| [props.encounter] | Reference | Encounter created as part of |
| [props.onset] | dateTime | Diagnosis date |
| [props.abatement] | dateTime | Age | Period | Range | string | When in resolution/remission |
| [props.recordedDate] | dateTime | Date record was first recorded |
| [props.recorder] | Reference | Who recorded the condition |
| [props.asserter] | Reference | Person who asserts this condition |
| [props.stage] | BackboneElement | Stage/grade, usually assessed formally |
| [props.evidence] | BackboneElement | Supporting evidence |
| [props.note] | Annotation | Additional information about the Condition |
builders.encounter
encounter(props)
Create a Encounter resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | Identifier(s) by which this encounter is known |
| [props.status] | string | planned |
| [props.statusHistory] | BackboneElement | List of past encounter statuses |
| [props.class] | string | Department in which the encounter took place. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzEncounterClassificationVS |
| [props.classHistory] | BackboneElement | List of past encounter classes |
| [props.type] | string | Specific type of encounter. Accepts all values from http://hl7.org/fhir/ValueSet/encounter-type |
| [props.serviceType] | string | Specific type of service. Accepts all values from http://hl7.org/fhir/ValueSet/service-type |
| [props.priority] | string | Indicates the urgency of the encounter. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ActPriority |
| [props.subject] | Reference | Patient associated with the encounter |
| [props.episodeOfCare] | Reference | Episode(s) of care that this encounter should be recorded against |
| [props.basedOn] | Reference | The ServiceRequest that initiated this encounter |
| [props.participant] | BackboneElement | List of participants involved in the encounter |
| [props.appointment] | Reference | The appointment that scheduled this encounter |
| [props.period] | Period | The start and end time of the encounter |
| [props.length] | Duration | Quantity of time the encounter lasted (less time absent) |
| [props.reasonCode] | string | Coded reason the encounter takes place. Accepts all values from http://hl7.org/fhir/ValueSet/encounter-reason |
| [props.reasonReference] | Reference | Reason the encounter takes place (reference) |
| [props.diagnosis] | BackboneElement | The list of diagnosis relevant to this encounter |
| [props.account] | Reference | The set of accounts that may be used for billing for this Encounter |
| [props.hospitalization] | BackboneElement | Details about the admission to a healthcare service |
| [props.location] | BackboneElement | Encounter location |
| [props.serviceProvider] | Reference | Health facility responsible for the encounter |
| [props.partOf] | Reference | Another Encounter this encounter is part of |
builders.episodeOfCare
episodeOfCare(props)
Create a EpisodeOfCare resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | Business Identifier(s) relevant for this EpisodeOfCare |
| [props.status] | string | planned |
| [props.statusHistory] | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) |
| [props.type] | string | Episode of care classification. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzEpisodeOfCareTypeVS |
| [props.diagnosis] | BackboneElement | The list of diagnosis relevant to this episode of care |
| [props.patient] | Reference | The patient who is the focus of this episode of care |
| [props.managingOrganization] | Reference | Organization that assumes care |
| [props.period] | Period | Start and end datest of the Episode of care |
| [props.referralRequest] | Reference | Originating Referral Request(s) |
| [props.careManager] | Reference | Care manager/care coordinator for the patient |
| [props.team] | Reference | Other practitioners facilitating this episode of care |
| [props.account] | Reference | The set of accounts that may be used for billing for this EpisodeOfCare |
builders.location
location(props)
Create a Location resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | Unique code or number identifying the location to its users |
| [props.status] | string | active |
| [props.operationalStatus] | string | The operational status of the location (typically only for a bed/room). Accepts all values from http://terminology.hl7.org/ValueSet/v2-0116 |
| [props.name] | string | Location Name |
| [props.alias] | string | A list of alternate names that the location is known as, or was known as, in the past |
| [props.description] | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
| [props.mode] | string | instance |
| [props.type] | string | Location Type. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType |
| [props.telecom] | ContactPoint | Contact details of the location |
| [props.address] | Address | Physical location |
| [props.physicalType] | string | Physical form of the location. Accepts all values from http://hl7.org/fhir/ValueSet/location-physical-type |
| [props.position] | BackboneElement | The absolute geographic location |
| [props.managingOrganization] | Reference | Organization responsible for provisioning and upkeep |
| [props.partOf] | Reference | Another Location this one is physically a part of |
| [props.hoursOfOperation] | BackboneElement | What days/times during a week is this location usually open |
| [props.availabilityExceptions] | string | Description of availability exceptions |
| [props.endpoint] | Reference | Technical endpoints providing access to services operated for the location |
builders.medication
medication(props)
Create a Medication resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | Business identifier for this medication |
| [props.code] | string | ELMIS Product Code. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzProductCodeVS |
| [props.status] | string | active |
| [props.manufacturer] | Reference | Manufacturer of the item |
| [props.form] | string | powder |
| [props.amount] | Ratio | Amount of drug in package |
| [props.ingredient] | BackboneElement | Active or inactive ingredient |
| [props.batch] | BackboneElement | Details about packaged medications |
builders.medicationDispense
medicationDispense(props)
Create a MedicationDispense resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | External identifier |
| [props.partOf] | Reference | Event that dispense is part of |
| [props.status] | string | preparation |
| [props.statusReason] | string | Why a dispense was not performed. Accepts all values from http://hl7.org/fhir/ValueSet/medicationdispense-status-reason |
| [props.category] | string | Type of medication dispense. Accepts all values from http://hl7.org/fhir/ValueSet/medicationdispense-category |
| [props.medication] | string | Supplied Medication. Accepts all values from http://hl7.org/fhir/ValueSet/medication-codes |
| [props.subject] | Reference | Who the dispense is for |
| [props.context] | Reference | Encounter / Episode associated with event |
| [props.supportingInformation] | Reference | Information that supports the dispensing of the medication |
| [props.performer] | BackboneElement | Dispensing Practitioner |
| [props.location] | Reference | Where the dispense occurred |
| [props.authorizingPrescription] | Reference | Medication order that authorizes the dispense |
| [props.type] | string | Trial fill, partial fill, emergency fill, etc.. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType |
| [props.quantity] | Quantity | Amount dispensed |
| [props.daysSupply] | Quantity | Amount of medication expressed as a timing amount |
| [props.whenPrepared] | dateTime | When product was packaged and reviewed |
| [props.whenHandedOver] | dateTime | When product was given out |
| [props.destination] | Reference | Where the medication was sent |
| [props.receiver] | Reference | Who collected the medication |
| [props.note] | Annotation | Information about the dispense |
| [props.dosageInstruction] | Dosage | How the medication is to be used by the patient or administered by the caregiver |
| [props.substitution] | BackboneElement | Whether a substitution was performed on the dispense |
| [props.detectedIssue] | Reference | Clinical issue with action |
| [props.eventHistory] | Reference | A list of relevant lifecycle events |
builders.medicationRequest
medicationRequest(props)
Create a MedicationRequest resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | External ids for this request |
| [props.status] | string | active |
| [props.statusReason] | string | Reason for current status. Accepts all values from http://hl7.org/fhir/ValueSet/medicationrequest-status-reason |
| [props.intent] | string | proposal |
| [props.category] | string | Type of medication usage. Accepts all values from http://hl7.org/fhir/ValueSet/medicationrequest-category |
| [props.priority] | string | routine |
| [props.doNotPerform] | boolean | True if request is prohibiting action |
| [props.reported] | boolean | Reference | Reported rather than primary record |
| [props.medication] | string | Medication to be taken. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzProductCodeVS |
| [props.subject] | Reference | Who or group medication request is for |
| [props.encounter] | Reference | Encounter created as part of encounter/admission/stay |
| [props.supportingInformation] | Reference | Information to support ordering of the medication |
| [props.authoredOn] | dateTime | Medication Request Date |
| [props.requester] | Reference | Who/What requested the Request |
| [props.performer] | Reference | Intended performer of administration |
| [props.performerType] | string | Desired kind of performer of the medication administration. Accepts all values from http://hl7.org/fhir/ValueSet/performer-role |
| [props.recorder] | Reference | Person who entered the request |
| [props.reasonCode] | string | Reason or indication for ordering or not ordering the medication. Accepts all values from http://hl7.org/fhir/ValueSet/condition-code |
| [props.reasonReference] | Reference | Condition or observation that supports why the prescription is being written |
| [props.instantiatesCanonical] | canonical | Instantiates FHIR protocol or definition |
| [props.instantiatesUri] | string | Instantiates external protocol or definition |
| [props.basedOn] | Reference | What request fulfills |
| [props.groupIdentifier] | Identifier | Composite request this is part of |
| [props.courseOfTherapyType] | string | Overall pattern of medication administration. Accepts all values from http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy |
| [props.insurance] | Reference | Associated insurance coverage |
| [props.note] | Annotation | Information about the prescription |
| [props.dosageInstruction] | Dosage | Dosage Instruction |
| [props.dispenseRequest] | BackboneElement | Medication supply authorization |
| [props.substitution] | BackboneElement | Any restrictions on medication substitution |
| [props.priorPrescription] | Reference | An order/prescription that is being replaced |
| [props.detectedIssue] | Reference | Clinical Issue with action |
| [props.eventHistory] | Reference | A list of events of interest in the lifecycle |
builders.observation
observation(type, props)
Create a Observation resource.
| Param | Type | Description |
|---|---|---|
| type | string | A profile type: one of SzCauseOfDeath,SzClinicalObservation,SzLabResult,SzMannerOfDeath,SzVitalSigns |
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | Business Identifier for observation |
| [props.basedOn] | Reference | Fulfills plan, proposal or order |
| [props.partOf] | Reference | Part of referenced event |
| [props.status] | string | registered |
| [props.category] | string | Classification of type of observation. Accepts all values from http://hl7.org/fhir/ValueSet/observation-category |
| [props.code] | string | Cause of death. Accepts all values from http://hl7.org/fhir/ValueSet/observation-codes |
| [props.subject] | Reference | The decedent |
| [props.focus] | Reference | What the observation is about, when it is not about the subject of record |
| [props.encounter] | Reference | Healthcare event during which this observation is made |
| [props.effective] | dateTime | Period | Timing | instant | Clinically relevant time/time-period for observation |
| [props.issued] | instant | Date/Time this version was made available |
| [props.performer] | Reference | Cause of death certifier (coroner or medical examiner) |
| [props.value] | CodeableConcept | Actual result |
| [props.dataAbsentReason] | string | Why the result is missing. Accepts all values from http://hl7.org/fhir/ValueSet/data-absent-reason |
| [props.interpretation] | string | High, low, normal, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/observation-interpretation |
| [props.note] | Annotation | Comments about the observation |
| [props.bodySite] | string | Observed body part. Accepts all values from http://hl7.org/fhir/ValueSet/body-site |
| [props.method] | string | How it was done. Accepts all values from http://hl7.org/fhir/ValueSet/observation-methods |
| [props.specimen] | Reference | Specimen used for this observation |
| [props.device] | Reference | (Measurement) Device |
| [props.referenceRange] | BackboneElement | Provides guide for interpretation |
| [props.hasMember] | Reference | Related resource that belongs to the Observation group |
| [props.derivedFrom] | Reference | Related measurements the observation is made from |
| [props.component] | BackboneElement | Cause of death time interval for Intermediate, Intermediate I, Intermediat II, Underlying |
builders.organization
organization(props)
Create a Organization resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | Identifies this organization across multiple systems |
| [props.active] | boolean | Whether the organization's record is still in active use |
| [props.type] | string | Organization Type. Accepts all values from http://hl7.org/fhir/ValueSet/organization-type |
| [props.name] | string | Organization' name |
| [props.alias] | string | A list of alternate names that the organization is known as, or was known as in the past |
| [props.telecom] | ContactPoint | A contact detail for the organization |
| [props.address] | Address | An address for the organization |
| [props.partOf] | Reference | The organization of which this organization forms a part |
| [props.contact] | BackboneElement | Contact for the organization for a certain purpose |
| [props.endpoint] | Reference | Technical endpoints providing access to services operated for the organization |
builders.patient
patient(props)
Create a Patient resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Extension |
| [props.nationality] | Extension | Nationality. |
| [props.inkhundla] | string | Extention: Eswatini Inkhundla. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzTinkhundlaVS |
| [props.chiefdom] | string | Extention: Eswatini Chiefdom. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzChiefdomVS |
| [props.registrationDate] | dateTime | Date the patient was registered |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | Patient's Identification Number |
| [props.active] | boolean | Whether this patient's record is in active use |
| [props.name] | HumanName | Patient's name |
| [props.telecom] | ContactPoint | A contact detail for the individual |
| [props.gender] | string | Sex at birth: male |
| [props.birthDate] | date | Date of birth: YYYY-MM-DD |
| [props.deceased] | boolean | dateTime | Indicates if the individual is deceased or not |
| [props.address] | Address | An address for the individual |
| [props.maritalStatus] | string | Marital (civil) status of a patient. Accepts all values from http://hl7.org/fhir/ValueSet/marital-status |
| [props.multipleBirth] | boolean | integer | Whether patient is part of a multiple birth |
| [props.photo] | Attachment | Image of the patient |
| [props.contact] | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
| [props.communication] | BackboneElement | A language which may be used to communicate with the patient about his or her health |
| [props.generalPractitioner] | Reference | Patient's nominated primary care provider |
| [props.managingOrganization] | Reference | Organization that is the custodian of the patient record |
| [props.link] | BackboneElement | Link to another patient resource that concerns the same actual person |
builders.practitioner
practitioner(props)
Create a Practitioner resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | An identifier for the person as this agent |
| [props.active] | boolean | Whether this practitioner's record is in active use |
| [props.name] | HumanName | Practitioner's name |
| [props.telecom] | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| [props.address] | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| [props.gender] | string | Sex at birth: male |
| [props.birthDate] | date | The date on which the practitioner was born |
| [props.photo] | Attachment | Image of the person |
| [props.qualification] | BackboneElement | Certification, licenses, or training pertaining to the provision of care |
| [props.communication] | string | A language the practitioner can use in patient communication. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
builders.procedure
procedure(props)
Create a Procedure resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | External Identifiers for this procedure |
| [props.instantiatesCanonical] | canonical | Instantiates FHIR protocol or definition |
| [props.instantiatesUri] | string | Instantiates external protocol or definition |
| [props.basedOn] | Reference | A request for this procedure |
| [props.partOf] | Reference | Part of referenced event |
| [props.status] | string | preparation |
| [props.statusReason] | string | Reason for current status. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-not-performed-reason |
| [props.category] | string | Classification of the procedure. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-category |
| [props.code] | string | Procedure Code. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-code |
| [props.subject] | Reference | Who the procedure was performed on |
| [props.encounter] | Reference | Encounter created as part of |
| [props.performed] | dateTime | Period | string | Age | Range | When the procedure was performed |
| [props.recorder] | Reference | Who recorded the procedure |
| [props.asserter] | Reference | Person who asserts this procedure |
| [props.performer] | BackboneElement | The people who performed the procedure |
| [props.location] | Reference | Where the procedure happened |
| [props.reasonCode] | string | Coded reason procedure performed. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-reason |
| [props.reasonReference] | Reference | The justification that the procedure was performed |
| [props.bodySite] | string | Target body sites. Accepts all values from http://hl7.org/fhir/ValueSet/body-site |
| [props.outcome] | string | The result of procedure. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-outcome |
| [props.report] | Reference | Any report resulting from the procedure |
| [props.complication] | string | Complication following the procedure. Accepts all values from http://hl7.org/fhir/ValueSet/condition-code |
| [props.complicationDetail] | Reference | A condition that is a result of the procedure |
| [props.followUp] | string | Instructions for follow up. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-followup |
| [props.note] | Annotation | Additional information about the procedure |
| [props.focalDevice] | BackboneElement | Manipulated, implanted, or removed device |
| [props.usedReference] | Reference | Items used during procedure |
| [props.usedCode] | string | Coded items used during the procedure. Accepts all values from http://hl7.org/fhir/ValueSet/device-kind |
builders.serviceRequest
serviceRequest(type, props)
Create a ServiceRequest resource.
| Param | Type | Description |
|---|---|---|
| type | string | A profile type: one of SzLabRequest,SzReferral |
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | Identifiers assigned to this order |
| [props.instantiatesCanonical] | canonical | Instantiates FHIR protocol or definition |
| [props.instantiatesUri] | string | Instantiates external protocol or definition |
| [props.basedOn] | Reference | What request fulfills |
| [props.replaces] | Reference | What request replaces |
| [props.requisition] | Identifier | Composite Request ID |
| [props.status] | string | draft |
| [props.intent] | string | proposal |
| [props.category] | string | Type of service request. Accepts all values from http://hl7.org/fhir/ValueSet/servicerequest-category |
| [props.priority] | string | routine |
| [props.doNotPerform] | boolean | True if service/procedure should not be performed |
| [props.code] | string | Local test code. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzTestCodeVS |
| [props.orderDetail] | string | Additional order information. Accepts all values from http://hl7.org/fhir/ValueSet/servicerequest-orderdetail |
| [props.quantity] | Quantity | Ratio | Range | Service amount |
| [props.subject] | Reference | Patient's information |
| [props.encounter] | Reference | Encounter information |
| [props.occurrence] | dateTime | Period | Timing | When service should occur |
| [props.asNeeded] | string | Preconditions for service. Accepts all values from http://hl7.org/fhir/ValueSet/medication-as-needed-reason |
| [props.authoredOn] | dateTime | Date request signed |
| [props.requester] | Reference | Who/what is requesting service |
| [props.performerType] | string | Performer role. Accepts all values from http://hl7.org/fhir/ValueSet/participant-role |
| [props.performer] | Reference | Requested performer |
| [props.locationCode] | string | Requested location. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType |
| [props.locationReference] | Reference | Requested location |
| [props.reasonCode] | string | Explanation/Justification for procedure or service. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-reason |
| [props.reasonReference] | Reference | Explanation/Justification for service or service |
| [props.insurance] | Reference | Associated insurance coverage |
| [props.supportingInfo] | Reference | Additional clinical information |
| [props.specimen] | Reference | Lab test specimen |
| [props.bodySite] | string | Location on Body. Accepts all values from http://hl7.org/fhir/ValueSet/body-site |
| [props.note] | Annotation | Comments |
| [props.patientInstruction] | string | Patient or consumer-oriented instructions |
| [props.relevantHistory] | Reference | Request provenance |
builders.specimen
specimen(props)
Create a Specimen resource.
| Param | Type | Description |
|---|---|---|
| props | object | Properties to apply to the resource (includes common and custom properties). |
| [props.id] | string | Logical id of this artifact |
| [props.meta] | Meta | Metadata about the resource |
| [props.implicitRules] | string | A set of rules under which this content was created |
| [props.language] | string | Language of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages |
| [props.text] | Narrative | Text summary of the resource, for human interpretation |
| [props.contained] | Resource | Contained, inline Resources |
| [props.extension] | Extension | Additional content defined by implementations |
| [props.modifierExtension] | Extension | Extensions that cannot be ignored |
| [props.identifier] | Identifier | External Identifier |
| [props.accessionIdentifier] | Identifier | Identifier assigned by the lab |
| [props.status] | string | available |
| [props.type] | string | Type of specimen being collected. Accepts all values from http://terminology.hl7.org/CodeSystem/v2-0487 |
| [props.subject] | Reference | Patient associated with the specimen being collected |
| [props.receivedTime] | dateTime | The time when specimen was received for processing |
| [props.parent] | Reference | Specimen from which this specimen originated |
| [props.request] | Reference | Why the specimen was collected |
| [props.collection] | BackboneElement | Specimen collection information |
| [props.processing] | BackboneElement | Processing and processing step details |
| [props.container] | BackboneElement | Direct container of specimen (tube/slide, etc.) |
| [props.condition] | string | State of the specimen. Accepts all values from http://terminology.hl7.org/ValueSet/v2-0493 |
| [props.note] | Annotation | Comments |