Skip to main content

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.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierExternal Ids for this item
[props.status]stringproposed
[props.cancelationReason]stringThe coded reason for the appointment being cancelled. Accepts all values from http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
[props.serviceCategory]stringA 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]stringThe specific service that is to be performed during this appointment. Accepts all values from http://hl7.org/fhir/ValueSet/service-type
[props.specialty]stringThe 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]stringThe 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]stringCoded reason this appointment is scheduled. Accepts all values from http://hl7.org/fhir/ValueSet/encounter-reason
[props.reasonReference]ReferenceReason the appointment is to take place (resource)
[props.priority]unsignedIntUsed to make informed decisions if needing to re-prioritize
[props.description]stringShown on a subject line in a meeting request, or appointment list
[props.supportingInformation]ReferenceAdditional information to support the appointment
[props.start]instantWhen appointment is to take place
[props.end]instantWhen appointment is to conclude
[props.minutesDuration]numberCan be less than start/end (e.g. estimate)
[props.slot]ReferenceThe slots that this appointment is filling
[props.created]dateTimeThe date that this appointment was initially created
[props.comment]stringAdditional comments
[props.patientInstruction]stringDetailed information and instructions for the patient
[props.basedOn]ReferenceThe service request this appointment is allocated to assess
[props.participant]BackboneElementParticipants involved in appointment
[props.requestedPeriod]PeriodPotential date/time interval(s) requested to allocate the appointment within

builders.condition

condition(props)

Create a Condition resource.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierExternal Ids for this condition
[props.clinicalStatus]stringactive
[props.verificationStatus]stringunconfirmed
[props.category]stringproblem-list-item
[props.severity]stringSubjective severity of condition. Accepts all values from http://hl7.org/fhir/ValueSet/condition-severity
[props.code]stringCondition Identification. Accepts all values from http://hl7.org/fhir/ValueSet/condition-code
[props.bodySite]stringAnatomical location, if relevant. Accepts all values from http://hl7.org/fhir/ValueSet/body-site
[props.subject]ReferenceWho has the condition?
[props.encounter]ReferenceEncounter created as part of
[props.onset]dateTimeDiagnosis date
[props.abatement]dateTime | Age | Period | Range | stringWhen in resolution/remission
[props.recordedDate]dateTimeDate record was first recorded
[props.recorder]ReferenceWho recorded the condition
[props.asserter]ReferencePerson who asserts this condition
[props.stage]BackboneElementStage/grade, usually assessed formally
[props.evidence]BackboneElementSupporting evidence
[props.note]AnnotationAdditional information about the Condition

builders.encounter

encounter(props)

Create a Encounter resource.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierIdentifier(s) by which this encounter is known
[props.status]stringplanned
[props.statusHistory]BackboneElementList of past encounter statuses
[props.class]stringDepartment in which the encounter took place. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzEncounterClassificationVS
[props.classHistory]BackboneElementList of past encounter classes
[props.type]stringSpecific type of encounter. Accepts all values from http://hl7.org/fhir/ValueSet/encounter-type
[props.serviceType]stringSpecific type of service. Accepts all values from http://hl7.org/fhir/ValueSet/service-type
[props.priority]stringIndicates the urgency of the encounter. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ActPriority
[props.subject]ReferencePatient associated with the encounter
[props.episodeOfCare]ReferenceEpisode(s) of care that this encounter should be recorded against
[props.basedOn]ReferenceThe ServiceRequest that initiated this encounter
[props.participant]BackboneElementList of participants involved in the encounter
[props.appointment]ReferenceThe appointment that scheduled this encounter
[props.period]PeriodThe start and end time of the encounter
[props.length]DurationQuantity of time the encounter lasted (less time absent)
[props.reasonCode]stringCoded reason the encounter takes place. Accepts all values from http://hl7.org/fhir/ValueSet/encounter-reason
[props.reasonReference]ReferenceReason the encounter takes place (reference)
[props.diagnosis]BackboneElementThe list of diagnosis relevant to this encounter
[props.account]ReferenceThe set of accounts that may be used for billing for this Encounter
[props.hospitalization]BackboneElementDetails about the admission to a healthcare service
[props.location]BackboneElementEncounter location
[props.serviceProvider]ReferenceHealth facility responsible for the encounter
[props.partOf]ReferenceAnother Encounter this encounter is part of

builders.episodeOfCare

episodeOfCare(props)

Create a EpisodeOfCare resource.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierBusiness Identifier(s) relevant for this EpisodeOfCare
[props.status]stringplanned
[props.statusHistory]BackboneElementPast list of status codes (the current status may be included to cover the start date of the status)
[props.type]stringEpisode of care classification. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzEpisodeOfCareTypeVS
[props.diagnosis]BackboneElementThe list of diagnosis relevant to this episode of care
[props.patient]ReferenceThe patient who is the focus of this episode of care
[props.managingOrganization]ReferenceOrganization that assumes care
[props.period]PeriodStart and end datest of the Episode of care
[props.referralRequest]ReferenceOriginating Referral Request(s)
[props.careManager]ReferenceCare manager/care coordinator for the patient
[props.team]ReferenceOther practitioners facilitating this episode of care
[props.account]ReferenceThe set of accounts that may be used for billing for this EpisodeOfCare

builders.location

location(props)

Create a Location resource.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierUnique code or number identifying the location to its users
[props.status]stringactive
[props.operationalStatus]stringThe operational status of the location (typically only for a bed/room). Accepts all values from http://terminology.hl7.org/ValueSet/v2-0116
[props.name]stringLocation Name
[props.alias]stringA list of alternate names that the location is known as, or was known as, in the past
[props.description]stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
[props.mode]stringinstance
[props.type]stringLocation Type. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
[props.telecom]ContactPointContact details of the location
[props.address]AddressPhysical location
[props.physicalType]stringPhysical form of the location. Accepts all values from http://hl7.org/fhir/ValueSet/location-physical-type
[props.position]BackboneElementThe absolute geographic location
[props.managingOrganization]ReferenceOrganization responsible for provisioning and upkeep
[props.partOf]ReferenceAnother Location this one is physically a part of
[props.hoursOfOperation]BackboneElementWhat days/times during a week is this location usually open
[props.availabilityExceptions]stringDescription of availability exceptions
[props.endpoint]ReferenceTechnical endpoints providing access to services operated for the location

builders.medication

medication(props)

Create a Medication resource.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierBusiness identifier for this medication
[props.code]stringELMIS Product Code. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzProductCodeVS
[props.status]stringactive
[props.manufacturer]ReferenceManufacturer of the item
[props.form]stringpowder
[props.amount]RatioAmount of drug in package
[props.ingredient]BackboneElementActive or inactive ingredient
[props.batch]BackboneElementDetails about packaged medications

builders.medicationDispense

medicationDispense(props)

Create a MedicationDispense resource.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierExternal identifier
[props.partOf]ReferenceEvent that dispense is part of
[props.status]stringpreparation
[props.statusReason]stringWhy a dispense was not performed. Accepts all values from http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
[props.category]stringType of medication dispense. Accepts all values from http://hl7.org/fhir/ValueSet/medicationdispense-category
[props.medication]stringSupplied Medication. Accepts all values from http://hl7.org/fhir/ValueSet/medication-codes
[props.subject]ReferenceWho the dispense is for
[props.context]ReferenceEncounter / Episode associated with event
[props.supportingInformation]ReferenceInformation that supports the dispensing of the medication
[props.performer]BackboneElementDispensing Practitioner
[props.location]ReferenceWhere the dispense occurred
[props.authorizingPrescription]ReferenceMedication order that authorizes the dispense
[props.type]stringTrial fill, partial fill, emergency fill, etc.. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
[props.quantity]QuantityAmount dispensed
[props.daysSupply]QuantityAmount of medication expressed as a timing amount
[props.whenPrepared]dateTimeWhen product was packaged and reviewed
[props.whenHandedOver]dateTimeWhen product was given out
[props.destination]ReferenceWhere the medication was sent
[props.receiver]ReferenceWho collected the medication
[props.note]AnnotationInformation about the dispense
[props.dosageInstruction]DosageHow the medication is to be used by the patient or administered by the caregiver
[props.substitution]BackboneElementWhether a substitution was performed on the dispense
[props.detectedIssue]ReferenceClinical issue with action
[props.eventHistory]ReferenceA list of relevant lifecycle events

builders.medicationRequest

medicationRequest(props)

Create a MedicationRequest resource.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierExternal ids for this request
[props.status]stringactive
[props.statusReason]stringReason for current status. Accepts all values from http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
[props.intent]stringproposal
[props.category]stringType of medication usage. Accepts all values from http://hl7.org/fhir/ValueSet/medicationrequest-category
[props.priority]stringroutine
[props.doNotPerform]booleanTrue if request is prohibiting action
[props.reported]boolean | ReferenceReported rather than primary record
[props.medication]stringMedication to be taken. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzProductCodeVS
[props.subject]ReferenceWho or group medication request is for
[props.encounter]ReferenceEncounter created as part of encounter/admission/stay
[props.supportingInformation]ReferenceInformation to support ordering of the medication
[props.authoredOn]dateTimeMedication Request Date
[props.requester]ReferenceWho/What requested the Request
[props.performer]ReferenceIntended performer of administration
[props.performerType]stringDesired kind of performer of the medication administration. Accepts all values from http://hl7.org/fhir/ValueSet/performer-role
[props.recorder]ReferencePerson who entered the request
[props.reasonCode]stringReason or indication for ordering or not ordering the medication. Accepts all values from http://hl7.org/fhir/ValueSet/condition-code
[props.reasonReference]ReferenceCondition or observation that supports why the prescription is being written
[props.instantiatesCanonical]canonicalInstantiates FHIR protocol or definition
[props.instantiatesUri]stringInstantiates external protocol or definition
[props.basedOn]ReferenceWhat request fulfills
[props.groupIdentifier]IdentifierComposite request this is part of
[props.courseOfTherapyType]stringOverall pattern of medication administration. Accepts all values from http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
[props.insurance]ReferenceAssociated insurance coverage
[props.note]AnnotationInformation about the prescription
[props.dosageInstruction]DosageDosage Instruction
[props.dispenseRequest]BackboneElementMedication supply authorization
[props.substitution]BackboneElementAny restrictions on medication substitution
[props.priorPrescription]ReferenceAn order/prescription that is being replaced
[props.detectedIssue]ReferenceClinical Issue with action
[props.eventHistory]ReferenceA list of events of interest in the lifecycle

builders.observation

observation(type, props)

Create a Observation resource.

ParamTypeDescription
typestringA profile type: one of SzCauseOfDeath,SzClinicalObservation,SzLabResult,SzMannerOfDeath,SzVitalSigns
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierBusiness Identifier for observation
[props.basedOn]ReferenceFulfills plan, proposal or order
[props.partOf]ReferencePart of referenced event
[props.status]stringregistered
[props.category]stringClassification of type of observation. Accepts all values from http://hl7.org/fhir/ValueSet/observation-category
[props.code]stringCause of death. Accepts all values from http://hl7.org/fhir/ValueSet/observation-codes
[props.subject]ReferenceThe decedent
[props.focus]ReferenceWhat the observation is about, when it is not about the subject of record
[props.encounter]ReferenceHealthcare event during which this observation is made
[props.effective]dateTime | Period | Timing | instantClinically relevant time/time-period for observation
[props.issued]instantDate/Time this version was made available
[props.performer]ReferenceCause of death certifier (coroner or medical examiner)
[props.value]CodeableConceptActual result
[props.dataAbsentReason]stringWhy the result is missing. Accepts all values from http://hl7.org/fhir/ValueSet/data-absent-reason
[props.interpretation]stringHigh, low, normal, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/observation-interpretation
[props.note]AnnotationComments about the observation
[props.bodySite]stringObserved body part. Accepts all values from http://hl7.org/fhir/ValueSet/body-site
[props.method]stringHow it was done. Accepts all values from http://hl7.org/fhir/ValueSet/observation-methods
[props.specimen]ReferenceSpecimen used for this observation
[props.device]Reference(Measurement) Device
[props.referenceRange]BackboneElementProvides guide for interpretation
[props.hasMember]ReferenceRelated resource that belongs to the Observation group
[props.derivedFrom]ReferenceRelated measurements the observation is made from
[props.component]BackboneElementCause of death time interval for Intermediate, Intermediate I, Intermediat II, Underlying

builders.organization

organization(props)

Create a Organization resource.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierIdentifies this organization across multiple systems
[props.active]booleanWhether the organization's record is still in active use
[props.type]stringOrganization Type. Accepts all values from http://hl7.org/fhir/ValueSet/organization-type
[props.name]stringOrganization' name
[props.alias]stringA list of alternate names that the organization is known as, or was known as in the past
[props.telecom]ContactPointA contact detail for the organization
[props.address]AddressAn address for the organization
[props.partOf]ReferenceThe organization of which this organization forms a part
[props.contact]BackboneElementContact for the organization for a certain purpose
[props.endpoint]ReferenceTechnical endpoints providing access to services operated for the organization

builders.patient

patient(props)

Create a Patient resource.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionExtension
[props.nationality]ExtensionNationality.
[props.inkhundla]stringExtention: Eswatini Inkhundla. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzTinkhundlaVS
[props.chiefdom]stringExtention: Eswatini Chiefdom. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzChiefdomVS
[props.registrationDate]dateTimeDate the patient was registered
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierPatient's Identification Number
[props.active]booleanWhether this patient's record is in active use
[props.name]HumanNamePatient's name
[props.telecom]ContactPointA contact detail for the individual
[props.gender]stringSex at birth: male
[props.birthDate]dateDate of birth: YYYY-MM-DD
[props.deceased]boolean | dateTimeIndicates if the individual is deceased or not
[props.address]AddressAn address for the individual
[props.maritalStatus]stringMarital (civil) status of a patient. Accepts all values from http://hl7.org/fhir/ValueSet/marital-status
[props.multipleBirth]boolean | integerWhether patient is part of a multiple birth
[props.photo]AttachmentImage of the patient
[props.contact]BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
[props.communication]BackboneElementA language which may be used to communicate with the patient about his or her health
[props.generalPractitioner]ReferencePatient's nominated primary care provider
[props.managingOrganization]ReferenceOrganization that is the custodian of the patient record
[props.link]BackboneElementLink to another patient resource that concerns the same actual person

builders.practitioner

practitioner(props)

Create a Practitioner resource.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierAn identifier for the person as this agent
[props.active]booleanWhether this practitioner's record is in active use
[props.name]HumanNamePractitioner's name
[props.telecom]ContactPointA contact detail for the practitioner (that apply to all roles)
[props.address]AddressAddress(es) of the practitioner that are not role specific (typically home address)
[props.gender]stringSex at birth: male
[props.birthDate]dateThe date on which the practitioner was born
[props.photo]AttachmentImage of the person
[props.qualification]BackboneElementCertification, licenses, or training pertaining to the provision of care
[props.communication]stringA 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.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierExternal Identifiers for this procedure
[props.instantiatesCanonical]canonicalInstantiates FHIR protocol or definition
[props.instantiatesUri]stringInstantiates external protocol or definition
[props.basedOn]ReferenceA request for this procedure
[props.partOf]ReferencePart of referenced event
[props.status]stringpreparation
[props.statusReason]stringReason for current status. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-not-performed-reason
[props.category]stringClassification of the procedure. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-category
[props.code]stringProcedure Code. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-code
[props.subject]ReferenceWho the procedure was performed on
[props.encounter]ReferenceEncounter created as part of
[props.performed]dateTime | Period | string | Age | RangeWhen the procedure was performed
[props.recorder]ReferenceWho recorded the procedure
[props.asserter]ReferencePerson who asserts this procedure
[props.performer]BackboneElementThe people who performed the procedure
[props.location]ReferenceWhere the procedure happened
[props.reasonCode]stringCoded reason procedure performed. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-reason
[props.reasonReference]ReferenceThe justification that the procedure was performed
[props.bodySite]stringTarget body sites. Accepts all values from http://hl7.org/fhir/ValueSet/body-site
[props.outcome]stringThe result of procedure. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-outcome
[props.report]ReferenceAny report resulting from the procedure
[props.complication]stringComplication following the procedure. Accepts all values from http://hl7.org/fhir/ValueSet/condition-code
[props.complicationDetail]ReferenceA condition that is a result of the procedure
[props.followUp]stringInstructions for follow up. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-followup
[props.note]AnnotationAdditional information about the procedure
[props.focalDevice]BackboneElementManipulated, implanted, or removed device
[props.usedReference]ReferenceItems used during procedure
[props.usedCode]stringCoded 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.

ParamTypeDescription
typestringA profile type: one of SzLabRequest,SzReferral
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierIdentifiers assigned to this order
[props.instantiatesCanonical]canonicalInstantiates FHIR protocol or definition
[props.instantiatesUri]stringInstantiates external protocol or definition
[props.basedOn]ReferenceWhat request fulfills
[props.replaces]ReferenceWhat request replaces
[props.requisition]IdentifierComposite Request ID
[props.status]stringdraft
[props.intent]stringproposal
[props.category]stringType of service request. Accepts all values from http://hl7.org/fhir/ValueSet/servicerequest-category
[props.priority]stringroutine
[props.doNotPerform]booleanTrue if service/procedure should not be performed
[props.code]stringLocal test code. Accepts all values from http://172.209.216.154:3447/fhir/ValueSet/SzTestCodeVS
[props.orderDetail]stringAdditional order information. Accepts all values from http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
[props.quantity]Quantity | Ratio | RangeService amount
[props.subject]ReferencePatient's information
[props.encounter]ReferenceEncounter information
[props.occurrence]dateTime | Period | TimingWhen service should occur
[props.asNeeded]stringPreconditions for service. Accepts all values from http://hl7.org/fhir/ValueSet/medication-as-needed-reason
[props.authoredOn]dateTimeDate request signed
[props.requester]ReferenceWho/what is requesting service
[props.performerType]stringPerformer role. Accepts all values from http://hl7.org/fhir/ValueSet/participant-role
[props.performer]ReferenceRequested performer
[props.locationCode]stringRequested location. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
[props.locationReference]ReferenceRequested location
[props.reasonCode]stringExplanation/Justification for procedure or service. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-reason
[props.reasonReference]ReferenceExplanation/Justification for service or service
[props.insurance]ReferenceAssociated insurance coverage
[props.supportingInfo]ReferenceAdditional clinical information
[props.specimen]ReferenceLab test specimen
[props.bodySite]stringLocation on Body. Accepts all values from http://hl7.org/fhir/ValueSet/body-site
[props.note]AnnotationComments
[props.patientInstruction]stringPatient or consumer-oriented instructions
[props.relevantHistory]ReferenceRequest provenance

builders.specimen

specimen(props)

Create a Specimen resource.

ParamTypeDescription
propsobjectProperties to apply to the resource (includes common and custom properties).
[props.id]stringLogical id of this artifact
[props.meta]MetaMetadata about the resource
[props.implicitRules]stringA set of rules under which this content was created
[props.language]stringLanguage of the resource content. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.text]NarrativeText summary of the resource, for human interpretation
[props.contained]ResourceContained, inline Resources
[props.extension]ExtensionAdditional content defined by implementations
[props.modifierExtension]ExtensionExtensions that cannot be ignored
[props.identifier]IdentifierExternal Identifier
[props.accessionIdentifier]IdentifierIdentifier assigned by the lab
[props.status]stringavailable
[props.type]stringType of specimen being collected. Accepts all values from http://terminology.hl7.org/CodeSystem/v2-0487
[props.subject]ReferencePatient associated with the specimen being collected
[props.receivedTime]dateTimeThe time when specimen was received for processing
[props.parent]ReferenceSpecimen from which this specimen originated
[props.request]ReferenceWhy the specimen was collected
[props.collection]BackboneElementSpecimen collection information
[props.processing]BackboneElementProcessing and processing step details
[props.container]BackboneElementDirect container of specimen (tube/slide, etc.)
[props.condition]stringState of the specimen. Accepts all values from http://terminology.hl7.org/ValueSet/v2-0493
[props.note]AnnotationComments