fhir-4@0.1.6
- addToBundle(resources, [name])
- create(resource)
- delete(reference)
- read(reference)
- search(resourceType, options)
- update(reference, resource)
- uploadBundle(bundle)
This adaptor exports the following namespaced functions:
- builders.account(type, props)
- builders.activityDefinition(type, props)
- builders.administrableProductDefinition(type, props)
- builders.adverseEvent(type, props)
- builders.allergyIntolerance(type, props)
- builders.appointment(type, props)
- builders.appointmentResponse(type, props)
- builders.biologicallyDerivedProduct(type, props)
- builders.bodyStructure(type, props)
- builders.carePlan(type, props)
- builders.careTeam(type, props)
- builders.chargeItem(type, props)
- builders.chargeItemDefinition(type, props)
- builders.citation(type, props)
- builders.claim(type, props)
- builders.claimResponse(type, props)
- builders.clinicalImpression(type, props)
- builders.clinicalUseDefinition(type, props)
- builders.communication(type, props)
- builders.communicationRequest(type, props)
- builders.contract(type, props)
- builders.coverage(type, props)
- builders.coverageEligibilityRequest(type, props)
- builders.coverageEligibilityResponse(type, props)
- builders.detectedIssue(type, props)
- builders.device(type, props)
- builders.deviceDefinition(type, props)
- builders.deviceMetric(type, props)
- builders.deviceRequest(type, props)
- builders.deviceUseStatement(type, props)
- builders.diagnosticReport(type, props)
- builders.domainResource(type, props)
- builders.encounter(type, props)
- builders.enrollmentRequest(type, props)
- builders.enrollmentResponse(type, props)
- builders.episodeOfCare(type, props)
- builders.eventDefinition(type, props)
- builders.evidence(type, props)
- builders.evidenceReport(type, props)
- builders.evidenceVariable(type, props)
- builders.explanationOfBenefit(type, props)
- builders.familyMemberHistory(type, props)
- builders.flag(type, props)
- builders.goal(type, props)
- builders.group(type, props)
- builders.guidanceResponse(type, props)
- builders.healthcareService(type, props)
- builders.imagingStudy(type, props)
- builders.immunization(type, props)
- builders.immunizationEvaluation(type, props)
- builders.immunizationRecommendation(type, props)
- builders.ingredient(type, props)
- builders.insurancePlan(type, props)
- builders.invoice(type, props)
- builders.library(type, props)
- builders.list(type, props)
- builders.location(type, props)
- builders.manufacturedItemDefinition(type, props)
- builders.measure(type, props)
- builders.measureReport(type, props)
- builders.media(type, props)
- builders.medication(type, props)
- builders.medicationAdministration(type, props)
- builders.medicationDispense(type, props)
- builders.medicationKnowledge(type, props)
- builders.medicationRequest(type, props)
- builders.medicationStatement(type, props)
- builders.medicinalProductDefinition(type, props)
- builders.molecularSequence(type, props)
- builders.nutritionOrder(type, props)
- builders.nutritionProduct(type, props)
- builders.observation(type, props)
- builders.observationDefinition(type, props)
- builders.organization(type, props)
- builders.organizationAffiliation(type, props)
- builders.packagedProductDefinition(type, props)
- builders.patient(type, props)
- builders.paymentNotice(type, props)
- builders.paymentReconciliation(type, props)
- builders.person(type, props)
- builders.planDefinition(type, props)
- builders.practitioner(type, props)
- builders.practitionerRole(type, props)
- builders.procedure(type, props)
- builders.questionnaire(type, props)
- builders.questionnaireResponse(type, props)
- builders.regulatedAuthorization(type, props)
- builders.relatedPerson(type, props)
- builders.requestGroup(type, props)
- builders.researchDefinition(type, props)
- builders.researchElementDefinition(type, props)
- builders.researchStudy(type, props)
- builders.researchSubject(type, props)
- builders.riskAssessment(type, props)
- builders.schedule(type, props)
- builders.serviceRequest(type, props)
- builders.slot(type, props)
- builders.specimen(type, props)
- builders.specimenDefinition(type, props)
- builders.substance(type, props)
- builders.substanceDefinition(type, props)
- builders.supplyDelivery(type, props)
- builders.supplyRequest(type, props)
- builders.task(type, props)
- builders.testReport(type, props)
- builders.verificationResult(type, props)
- builders.visionPrescription(type, props)
- datatypes.addExtension(resource, url, value)
- datatypes.cc()
- datatypes.coding(code, system)
- datatypes.composite(object, key, value)
- datatypes.concept(value, extra)
- datatypes.ext()
- datatypes.extension(url, value, props)
- datatypes.findExtension(obj, targetUrl, [path])
- datatypes.id()
- datatypes.identifier(id, ext, [system])
- datatypes.ref()
- datatypes.reference(ref)
- datatypes.setSystemMap()
Functions
addToBundle
addToBundle(resources, [name]) ⇒
Add a resource to a bundle on state, using the name
as the key (or bundle
by default).
The resource will be upserted (via PUT).
A new bundle will be generated if one does not already exist.
Returns: Operation
Param | Type | Description |
---|---|---|
resources | object/array | A resource or array of resources to add to the bundle |
[name] | string | A name (key) for this bundle on state (defaults to bundle ) |
This operation writes the following keys to state:
State Key | Description |
---|---|
bundle | the updated bundle |
Example: Add a new patient resource to the default bundle
addToBundle(b.patient($.patientDetails))
create
create(resource) ⇒
Create a new resource. The resource does not need to include an id. The created resource will be returned to state.data.
Returns: Operation
Param | Type | Description |
---|---|---|
resource | object | The resource to create. |
This operation writes the following keys to state:
State Key | Description |
---|---|
data | the newly created resource. |
response | the HTTP response returned by the server. |
Example: Create a Patient with a builder function
create(b.patient({
name: { family: "Messi", given: "Lionel", use: "official" },
}))
delete
delete(reference) ⇒
Delete a single FHIR resource.
Returns: Operation
Param | Type | Description |
---|---|---|
reference | string | The type and ID of the resource to delete, eg, Patient/123 |
This operation writes the following keys to state:
State Key | Description |
---|---|
response | the HTTP response returned by the server. |
Example: Delete a single Patient resource
delete('Patient/12345')
read
read(reference) ⇒
Fetch a single FHIR resource.
Returns: Operation
Param | Type | Description |
---|---|---|
reference | string | The type and ID of the resource to read, eg, Patient/123 |
This operation writes the following keys to state:
State Key | Description |
---|---|
data | the newly updated resource, as returned by the server |
response | the HTTP response returned by the server. |
Example: Read a single Patient resource
read('Patient/12345')
search
search(resourceType, options) ⇒
Search for matching FHIR resources. Exclude _ from search parameters, and pass query terms on options.query.
Returns: Operation
Param | Type | Description |
---|---|---|
resourceType | string | The type of the resource to search for. |
options | object | Parameters, query and filter. |
[options.*] | object | Pass supported query parameters without underscore. See FHIR Search Summary. |
[options.query] | object | query terms to search for. These are appended to the query URL veratim.. |
This operation writes the following keys to state:
State Key | Description |
---|---|
data | the newly updated resource, as returned by the server |
response | the HTTP response returned by the server. |
Example: Search with parameter and query term
search('Patient', {
lastUpdated: $.cursor,
count: 10,
query: { given: 'messi' },
})
Example: Search for patients with a given name containing "eve"
search('Patient', {
query: { 'given:contains': 'eve' },
})
update
update(reference, resource) ⇒
Update a resource. If the resource does not already exist, it will be created and state.response.statusCode
will be 201.
Otherwise, the existing resource will be replaced.
To partially update a resource, use patch()
.
Returns: Operation
Param | Type | Description |
---|---|---|
reference | string | The type and ID of the resource to update, eg, Patient/123 |
resource | object | The new version of this resource. |
This operation writes the following keys to state:
State Key | Description |
---|---|
data | the newly updated resource, as returned by the server |
response | the HTTP response returned by the server. |
Example: Update a Patient with a builder function
update('Patient/123', b.patient({
id: 'Patient/123',
name: { family: "Messi", given: "Lionel", use: "official" },
}))
uploadBundle
uploadBundle(bundle) ⇒
Upload a bundle from state (created by addToBundle) as a transaction.
Returns: Operation
Param | Type | Description |
---|---|---|
bundle | string/object | A bundle object or name of a bundle on state |
Example: Upload the default bundle
uploadBundle()
Example: Create and a bundle with a custom name
addToBundle($.patients, 'patientsBundle')
uploadBundle('patientsBundle')
Example: Upload a bundle from state
uploadBundle($.patientsBundle)
builders
These functions belong to the builders namespace.
builders.account
account(type, props)
Create a FHIR Account resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Account number |
[props.status] | string | active |
[props.type] | CodeableConcept | E.g. patient, expense, depreciation |
[props.name] | string | Human-readable label |
[props.subject] | Reference | The entity that caused the expenses |
[props.servicePeriod] | Period | Transaction window |
[props.coverage] | BackboneElement | The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account |
[props.owner] | Reference | Entity managing the Account |
[props.description] | string | Explanation of purpose/use |
[props.guarantor] | BackboneElement | The parties ultimately responsible for balancing the Account |
[props.partOf] | Reference | Reference to a parent Account |
builders.activityDefinition
activityDefinition(type, props)
Create a FHIR ActivityDefinition resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.url] | string | Canonical identifier for this activity definition, represented as a URI (globally unique) |
[props.identifier] | Identifier | Additional identifier for the activity definition |
[props.version] | string | Business version of the activity definition |
[props.name] | string | Name for this activity definition (computer friendly) |
[props.title] | string | Name for this activity definition (human friendly) |
[props.subtitle] | string | Subordinate title of the activity definition |
[props.status] | string | draft |
[props.experimental] | boolean | For testing purposes, not real usage |
[props.subject] | CodeableConcept | Reference | canonical | Type of individual the activity definition is intended for |
[props.date] | dateTime | Date last changed |
[props.publisher] | string | Name of the publisher (organization or individual) |
[props.contact] | ContactDetail | Contact details for the publisher |
[props.description] | markdown | Natural language description of the activity definition |
[props.useContext] | UsageContext | The context that the content is intended to support |
[props.jurisdiction] | CodeableConcept | Intended jurisdiction for activity definition (if applicable) |
[props.purpose] | markdown | Why this activity definition is defined |
[props.usage] | string | Describes the clinical usage of the activity definition |
[props.copyright] | markdown | Use and/or publishing restrictions |
[props.approvalDate] | date | When the activity definition was approved by publisher |
[props.lastReviewDate] | date | When the activity definition was last reviewed |
[props.effectivePeriod] | Period | When the activity definition is expected to be used |
[props.topic] | CodeableConcept | E.g. Education, Treatment, Assessment, etc. |
[props.author] | ContactDetail | Who authored the content |
[props.editor] | ContactDetail | Who edited the content |
[props.reviewer] | ContactDetail | Who reviewed the content |
[props.endorser] | ContactDetail | Who endorsed the content |
[props.relatedArtifact] | RelatedArtifact | Additional documentation, citations, etc. |
[props.library] | canonical | Logic used by the activity definition |
[props.kind] | string | Kind of resource |
[props.profile] | canonical | What profile the resource needs to conform to |
[props.code] | CodeableConcept | Detail type of activity |
[props.intent] | string | proposal |
[props.priority] | string | routine |
[props.doNotPerform] | boolean | True if the activity should not be performed |
[props.timing] | Timing | dateTime | Age | Period | Range | Duration | When activity is to occur |
[props.location] | Reference | Where it should happen |
[props.participant] | BackboneElement | Who should participate in the action |
[props.product] | Reference | CodeableConcept | What's administered/supplied |
[props.quantity] | Quantity | How much is administered/consumed/supplied |
[props.dosage] | Dosage | Detailed dosage instructions |
[props.bodySite] | CodeableConcept | What part of body to perform on |
[props.specimenRequirement] | Reference | What specimens are required to perform this action |
[props.observationRequirement] | Reference | What observations are required to perform this action |
[props.observationResultRequirement] | Reference | What observations must be produced by this action |
[props.transform] | canonical | Transform to apply the template |
[props.dynamicValue] | BackboneElement | Dynamic aspects of the definition |
builders.administrableProductDefinition
administrableProductDefinition(type, props)
Create a FHIR AdministrableProductDefinition resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | An identifier for the administrable product |
[props.status] | string | draft |
[props.formOf] | Reference | References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product |
[props.administrableDoseForm] | CodeableConcept | The dose form of the final product after necessary reconstitution or processing |
[props.unitOfPresentation] | CodeableConcept | The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' |
[props.producedFrom] | Reference | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form |
[props.ingredient] | CodeableConcept | The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton, or using by incoming references from the Ingredient resource |
[props.device] | Reference | A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product |
[props.property] | BackboneElement | Characteristics e.g. a product's onset of action |
[props.routeOfAdministration] | BackboneElement | The path by which the product is taken into or makes contact with the body |
builders.adverseEvent
adverseEvent(type, props)
Create a FHIR AdverseEvent resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Business identifier for the event |
[props.actuality] | string | actual |
[props.category] | CodeableConcept | product-problem |
[props.event] | CodeableConcept | Type of the event itself in relation to the subject |
[props.subject] | Reference | Subject impacted by event |
[props.encounter] | Reference | Encounter created as part of |
[props.date] | dateTime | When the event occurred |
[props.detected] | dateTime | When the event was detected |
[props.recordedDate] | dateTime | When the event was recorded |
[props.resultingCondition] | Reference | Effect on the subject due to this event |
[props.location] | Reference | Location where adverse event occurred |
[props.seriousness] | CodeableConcept | Seriousness of the event |
[props.severity] | CodeableConcept | mild |
[props.outcome] | CodeableConcept | resolved |
[props.recorder] | Reference | Who recorded the adverse event |
[props.contributor] | Reference | Who was involved in the adverse event or the potential adverse event |
[props.suspectEntity] | BackboneElement | The suspected agent causing the adverse event |
[props.subjectMedicalHistory] | Reference | AdverseEvent.subjectMedicalHistory |
[props.referenceDocument] | Reference | AdverseEvent.referenceDocument |
[props.study] | Reference | AdverseEvent.study |
builders.allergyIntolerance
allergyIntolerance(type, props)
Create a FHIR AllergyIntolerance resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | External ids for this item |
[props.clinicalStatus] | CodeableConcept | active |
[props.verificationStatus] | CodeableConcept | unconfirmed |
[props.type] | string | allergy |
[props.category] | string | food |
[props.criticality] | string | low |
[props.code] | CodeableConcept | Code that identifies the allergy or intolerance |
[props.patient] | Reference | Who the sensitivity is for |
[props.encounter] | Reference | Encounter when the allergy or intolerance was asserted |
[props.onset] | dateTime | Age | Period | Range | string | When allergy or intolerance was identified |
[props.recordedDate] | dateTime | Date first version of the resource instance was recorded |
[props.recorder] | Reference | Who recorded the sensitivity |
[props.asserter] | Reference | Source of the information about the allergy |
[props.lastOccurrence] | dateTime | Date(/time) of last known occurrence of a reaction |
[props.note] | Annotation | Additional text not captured in other fields |
[props.reaction] | BackboneElement | Adverse Reaction Events linked to exposure to substance |
builders.appointment
appointment(type, props)
Create a FHIR Appointment resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | External Ids for this item |
[props.status] | string | proposed |
[props.cancelationReason] | CodeableConcept | The coded reason for the appointment being cancelled |
[props.serviceCategory] | CodeableConcept | A broad categorization of the service that is to be performed during this appointment |
[props.serviceType] | CodeableConcept | The specific service that is to be performed during this appointment |
[props.specialty] | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment |
[props.appointmentType] | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) |
[props.reasonCode] | CodeableConcept | Coded reason this appointment is scheduled |
[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.appointmentResponse
appointmentResponse(type, props)
Create a FHIR AppointmentResponse resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | External Ids for this item |
[props.appointment] | Reference | Appointment this response relates to |
[props.start] | instant | Time from appointment, or requested new start time |
[props.end] | instant | Time from appointment, or requested new end time |
[props.participantType] | CodeableConcept | Role of participant in the appointment |
[props.actor] | Reference | Person, Location, HealthcareService, or Device |
[props.participantStatus] | string | accepted |
[props.comment] | string | Additional comments |
builders.biologicallyDerivedProduct
biologicallyDerivedProduct(type, props)
Create a FHIR BiologicallyDerivedProduct resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | External ids for this item |
[props.productCategory] | string | organ |
[props.productCode] | CodeableConcept | What this biologically derived product is |
[props.status] | string | available |
[props.request] | Reference | Procedure request |
[props.quantity] | integer | The amount of this biologically derived product |
[props.parent] | Reference | BiologicallyDerivedProduct parent |
[props.collection] | BackboneElement | How this product was collected |
[props.processing] | BackboneElement | Any processing of the product during collection |
[props.manipulation] | BackboneElement | Any manipulation of product post-collection |
[props.storage] | BackboneElement | Product storage |
builders.bodyStructure
bodyStructure(type, props)
Create a FHIR BodyStructure resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Bodystructure identifier |
[props.active] | boolean | Whether this record is in active use |
[props.morphology] | CodeableConcept | Kind of Structure |
[props.location] | CodeableConcept | Body site |
[props.locationQualifier] | CodeableConcept | Body site modifier |
[props.description] | string | Text description |
[props.image] | Attachment | Attached images |
[props.patient] | Reference | Who this is about |
builders.carePlan
carePlan(type, props)
Create a FHIR CarePlan resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | External Ids for this plan |
[props.instantiatesCanonical] | canonical | Instantiates FHIR protocol or definition |
[props.instantiatesUri] | string | Instantiates external protocol or definition |
[props.basedOn] | Reference | Fulfills CarePlan |
[props.replaces] | Reference | CarePlan replaced by this CarePlan |
[props.partOf] | Reference | Part of referenced CarePlan |
[props.status] | string | draft |
[props.intent] | string | proposal |
[props.category] | CodeableConcept | Type of plan |
[props.title] | string | Human-friendly name for the care plan |
[props.description] | string | Summary of nature of plan |
[props.subject] | Reference | Who the care plan is for |
[props.encounter] | Reference | Encounter created as part of |
[props.period] | Period | Time period plan covers |
[props.created] | dateTime | Date record was first recorded |
[props.author] | Reference | Who is the designated responsible party |
[props.contributor] | Reference | Who provided the content of the care plan |
[props.careTeam] | Reference | Who's involved in plan? |
[props.addresses] | Reference | Health issues this plan addresses |
[props.supportingInfo] | Reference | Information considered as part of plan |
[props.goal] | Reference | Desired outcome of plan |
[props.activity] | BackboneElement | Action to occur as part of plan |
[props.note] | Annotation | Comments about the plan |
builders.careTeam
careTeam(type, props)
Create a FHIR CareTeam resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | External Ids for this team |
[props.status] | string | proposed |
[props.category] | CodeableConcept | Type of team |
[props.name] | string | Name of the team, such as crisis assessment team |
[props.subject] | Reference | Who care team is for |
[props.encounter] | Reference | Encounter created as part of |
[props.period] | Period | Time period team covers |
[props.participant] | BackboneElement | Members of the team |
[props.reasonCode] | CodeableConcept | Why the care team exists |
[props.reasonReference] | Reference | Why the care team exists |
[props.managingOrganization] | Reference | Organization responsible for the care team |
[props.telecom] | ContactPoint | A contact detail for the care team (that applies to all members) |
[props.note] | Annotation | Comments made about the CareTeam |
builders.chargeItem
chargeItem(type, props)
Create a FHIR ChargeItem resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Business Identifier for item |
[props.definitionUri] | string | Defining information about the code of this charge item |
[props.definitionCanonical] | canonical | Resource defining the code of this ChargeItem |
[props.status] | string | planned |
[props.partOf] | Reference | Part of referenced ChargeItem |
[props.code] | CodeableConcept | A code that identifies the charge, like a billing code |
[props.subject] | Reference | Individual service was done for/to |
[props.context] | Reference | Encounter / Episode associated with event |
[props.occurrence] | dateTime | Period | Timing | When the charged service was applied |
[props.performer] | BackboneElement | Who performed charged service |
[props.performingOrganization] | Reference | Organization providing the charged service |
[props.requestingOrganization] | Reference | Organization requesting the charged service |
[props.costCenter] | Reference | Organization that has ownership of the (potential, future) revenue |
[props.quantity] | Quantity | Quantity of which the charge item has been serviced |
[props.bodysite] | CodeableConcept | Anatomical location, if relevant |
[props.factorOverride] | decimal | Factor overriding the associated rules |
[props.priceOverride] | Money | Price overriding the associated rules |
[props.overrideReason] | string | Reason for overriding the list price/factor |
[props.enterer] | Reference | Individual who was entering |
[props.enteredDate] | dateTime | Date the charge item was entered |
[props.reason] | CodeableConcept | Why was the charged service rendered? |
[props.service] | Reference | Which rendered service is being charged? |
[props.product] | Reference | CodeableConcept | Product charged |
[props.account] | Reference | Account to place this charge |
[props.note] | Annotation | Comments made about the ChargeItem |
[props.supportingInformation] | Reference | Further information supporting this charge |
builders.chargeItemDefinition
chargeItemDefinition(type, props)
Create a FHIR ChargeItemDefinition resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.url] | string | Canonical identifier for this charge item definition, represented as a URI (globally unique) |
[props.identifier] | Identifier | Additional identifier for the charge item definition |
[props.version] | string | Business version of the charge item definition |
[props.title] | string | Name for this charge item definition (human friendly) |
[props.derivedFromUri] | string | Underlying externally-defined charge item definition |
[props.partOf] | canonical | A larger definition of which this particular definition is a component or step |
[props.replaces] | canonical | Completed or terminated request(s) whose function is taken by this new request |
[props.status] | string | draft |
[props.experimental] | boolean | For testing purposes, not real usage |
[props.date] | dateTime | Date last changed |
[props.publisher] | string | Name of the publisher (organization or individual) |
[props.contact] | ContactDetail | Contact details for the publisher |
[props.description] | markdown | Natural language description of the charge item definition |
[props.useContext] | UsageContext | The context that the content is intended to support |
[props.jurisdiction] | CodeableConcept | Intended jurisdiction for charge item definition (if applicable) |
[props.copyright] | markdown | Use and/or publishing restrictions |
[props.approvalDate] | date | When the charge item definition was approved by publisher |
[props.lastReviewDate] | date | When the charge item definition was last reviewed |
[props.effectivePeriod] | Period | When the charge item definition is expected to be used |
[props.code] | CodeableConcept | Billing codes or product types this definition applies to |
[props.instance] | Reference | Instances this definition applies to |
[props.applicability] | BackboneElement | Whether or not the billing code is applicable |
[props.propertyGroup] | BackboneElement | Group of properties which are applicable under the same conditions |
builders.citation
citation(type, props)
Create a FHIR Citation resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.url] | string | Canonical identifier for this citation, represented as a globally unique URI |
[props.identifier] | Identifier | Identifier for the Citation resource itself |
[props.version] | string | Business version of the citation |
[props.name] | string | Name for this citation (computer friendly) |
[props.title] | string | Name for this citation (human friendly) |
[props.status] | string | draft |
[props.experimental] | boolean | For testing purposes, not real usage |
[props.date] | dateTime | Date last changed |
[props.publisher] | string | The publisher of the Citation, not the publisher of the article or artifact being cited |
[props.contact] | ContactDetail | Contact details for the publisher of the Citation Resource |
[props.description] | markdown | Natural language description of the citation |
[props.useContext] | UsageContext | The context that the Citation Resource content is intended to support |
[props.jurisdiction] | CodeableConcept | Intended jurisdiction for citation (if applicable) |
[props.purpose] | markdown | Why this citation is defined |
[props.copyright] | markdown | Use and/or publishing restrictions for the Citation, not for the cited artifact |
[props.approvalDate] | date | When the citation was approved by publisher |
[props.lastReviewDate] | date | When the citation was last reviewed |
[props.effectivePeriod] | Period | When the citation is expected to be used |
[props.author] | ContactDetail | Who authored the Citation |
[props.editor] | ContactDetail | Who edited the Citation |
[props.reviewer] | ContactDetail | Who reviewed the Citation |
[props.endorser] | ContactDetail | Who endorsed the Citation |
[props.summary] | BackboneElement | A human-readable display of the citation |
[props.classification] | BackboneElement | The assignment to an organizing scheme |
[props.note] | Annotation | Used for general notes and annotations not coded elsewhere |
[props.currentState] | CodeableConcept | The status of the citation |
[props.statusDate] | BackboneElement | An effective date or period for a status of the citation |
[props.relatesTo] | BackboneElement | Artifact related to the Citation Resource |
[props.citedArtifact] | BackboneElement | The article or artifact being described |
builders.claim
claim(type, props)
Create a FHIR Claim resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Business Identifier for claim |
[props.status] | string | active |
[props.type] | CodeableConcept | Category or discipline |
[props.subType] | CodeableConcept | More granular claim type |
[props.use] | string | claim |
[props.patient] | Reference | The recipient of the products and services |
[props.billablePeriod] | Period | Relevant time frame for the claim |
[props.created] | dateTime | Resource creation date |
[props.enterer] | Reference | Author of the claim |
[props.insurer] | Reference | Target |
[props.provider] | Reference | Party responsible for the claim |
[props.priority] | CodeableConcept | Desired processing ugency |
[props.fundsReserve] | CodeableConcept | For whom to reserve funds |
[props.related] | BackboneElement | Prior or corollary claims |
[props.prescription] | Reference | Prescription authorizing services and products |
[props.originalPrescription] | Reference | Original prescription if superseded by fulfiller |
[props.payee] | BackboneElement | Recipient of benefits payable |
[props.referral] | Reference | Treatment referral |
[props.facility] | Reference | Servicing facility |
[props.careTeam] | BackboneElement | Members of the care team |
[props.supportingInfo] | BackboneElement | Supporting information |
[props.diagnosis] | BackboneElement | Pertinent diagnosis information |
[props.procedure] | BackboneElement | Clinical procedures performed |
[props.insurance] | BackboneElement | Patient insurance information |
[props.accident] | BackboneElement | Details of the event |
[props.item] | BackboneElement | Product or service provided |
[props.total] | Money | Total claim cost |
builders.claimResponse
claimResponse(type, props)
Create a FHIR ClaimResponse resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Business Identifier for a claim response |
[props.status] | string | active |
[props.type] | CodeableConcept | More granular claim type |
[props.subType] | CodeableConcept | More granular claim type |
[props.use] | string | claim |
[props.patient] | Reference | The recipient of the products and services |
[props.created] | dateTime | Response creation date |
[props.insurer] | Reference | Party responsible for reimbursement |
[props.requestor] | Reference | Party responsible for the claim |
[props.request] | Reference | Id of resource triggering adjudication |
[props.outcome] | string | queued |
[props.disposition] | string | Disposition Message |
[props.preAuthRef] | string | Preauthorization reference |
[props.preAuthPeriod] | Period | Preauthorization reference effective period |
[props.payeeType] | CodeableConcept | Party to be paid any benefits payable |
[props.item] | BackboneElement | Adjudication for claim line items |
[props.addItem] | BackboneElement | Insurer added line items |
[props.adjudication] | any | Header-level adjudication |
[props.total] | BackboneElement | Adjudication totals |
[props.payment] | BackboneElement | Payment Details |
[props.fundsReserve] | CodeableConcept | Funds reserved status |
[props.formCode] | CodeableConcept | Printed form identifier |
[props.form] | Attachment | Printed reference or actual form |
[props.processNote] | BackboneElement | Note concerning adjudication |
[props.communicationRequest] | Reference | Request for additional information |
[props.insurance] | BackboneElement | Patient insurance information |
[props.error] | BackboneElement | Processing errors |
builders.clinicalImpression
clinicalImpression(type, props)
Create a FHIR ClinicalImpression resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Business identifier |
[props.status] | string | in-progress |
[props.statusReason] | CodeableConcept | Reason for current status |
[props.code] | CodeableConcept | Kind of assessment performed |
[props.description] | string | Why/how the assessment was performed |
[props.subject] | Reference | Patient or group assessed |
[props.encounter] | Reference | Encounter created as part of |
[props.effective] | dateTime | Period | Time of assessment |
[props.date] | dateTime | When the assessment was documented |
[props.assessor] | Reference | The clinician performing the assessment |
[props.previous] | Reference | Reference to last assessment |
[props.problem] | Reference | Relevant impressions of patient state |
[props.investigation] | BackboneElement | One or more sets of investigations (signs, symptoms, etc.) |
[props.protocol] | string | Clinical Protocol followed |
[props.summary] | string | Summary of the assessment |
[props.finding] | BackboneElement | Possible or likely findings and diagnoses |
[props.prognosisCodeableConcept] | CodeableConcept | Estimate of likely outcome |
[props.prognosisReference] | Reference | RiskAssessment expressing likely outcome |
[props.supportingInfo] | Reference | Information supporting the clinical impression |
[props.note] | Annotation | Comments made about the ClinicalImpression |
builders.clinicalUseDefinition
clinicalUseDefinition(type, props)
Create a FHIR ClinicalUseDefinition resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Business identifier for this issue |
[props.type] | string | indication |
[props.category] | CodeableConcept | A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose" |
[props.subject] | Reference | The medication or procedure for which this is an indication |
[props.status] | CodeableConcept | Whether this is a current issue or one that has been retired etc |
[props.contraindication] | BackboneElement | Specifics for when this is a contraindication |
[props.indication] | BackboneElement | Specifics for when this is an indication |
[props.interaction] | BackboneElement | Specifics for when this is an interaction |
[props.population] | Reference | The population group to which this applies |
[props.undesirableEffect] | BackboneElement | A possible negative outcome from the use of this treatment |
[props.warning] | BackboneElement | Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness' |
builders.communication
communication(type, props)
Create a FHIR Communication resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Unique identifier |
[props.instantiatesCanonical] | canonical | Instantiates FHIR protocol or definition |
[props.instantiatesUri] | string | Instantiates external protocol or definition |
[props.basedOn] | Reference | Request fulfilled by this communication |
[props.partOf] | Reference | Part of this action |
[props.inResponseTo] | Reference | Reply to |
[props.status] | string | preparation |
[props.statusReason] | CodeableConcept | Reason for current status |
[props.category] | CodeableConcept | Message category |
[props.priority] | string | routine |
[props.medium] | CodeableConcept | A channel of communication |
[props.subject] | Reference | Focus of message |
[props.topic] | CodeableConcept | Description of the purpose/content |
[props.about] | Reference | Resources that pertain to this communication |
[props.encounter] | Reference | Encounter created as part of |
[props.sent] | dateTime | When sent |
[props.received] | dateTime | When received |
[props.recipient] | Reference | Message recipient |
[props.sender] | Reference | Message sender |
[props.reasonCode] | CodeableConcept | Indication for message |
[props.reasonReference] | Reference | Why was communication done? |
[props.payload] | BackboneElement | Message payload |
[props.note] | Annotation | Comments made about the communication |
builders.communicationRequest
communicationRequest(type, props)
Create a FHIR CommunicationRequest resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Unique identifier |
[props.basedOn] | Reference | Fulfills plan or proposal |
[props.replaces] | Reference | Request(s) replaced by this request |
[props.groupIdentifier] | Identifier | Composite request this is part of |
[props.status] | string | draft |
[props.statusReason] | CodeableConcept | Reason for current status |
[props.category] | CodeableConcept | Message category |
[props.priority] | string | routine |
[props.doNotPerform] | boolean | True if request is prohibiting action |
[props.medium] | CodeableConcept | A channel of communication |
[props.subject] | Reference | Focus of message |
[props.about] | Reference | Resources that pertain to this communication request |
[props.encounter] | Reference | Encounter created as part of |
[props.payload] | BackboneElement | Message payload |
[props.occurrence] | dateTime | Period | When scheduled |
[props.authoredOn] | dateTime | When request transitioned to being actionable |
[props.requester] | Reference | Who/what is requesting service |
[props.recipient] | Reference | Message recipient |
[props.sender] | Reference | Message sender |
[props.reasonCode] | CodeableConcept | Why is communication needed? |
[props.reasonReference] | Reference | Why is communication needed? |
[props.note] | Annotation | Comments made about communication request |
builders.contract
contract(type, props)
Create a FHIR Contract resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Contract number |
[props.url] | string | Basal definition |
[props.version] | string | Business edition |
[props.status] | string | amended |
[props.legalState] | CodeableConcept | Negotiation status |
[props.instantiatesCanonical] | Reference | Source Contract Definition |
[props.instantiatesUri] | string | External Contract Definition |
[props.contentDerivative] | CodeableConcept | Content derived from the basal information |
[props.issued] | dateTime | When this Contract was issued |
[props.applies] | Period | Effective time |
[props.expirationType] | CodeableConcept | Contract cessation cause |
[props.subject] | Reference | Contract Target Entity |
[props.authority] | Reference | Authority under which this Contract has standing |
[props.domain] | Reference | A sphere of control governed by an authoritative jurisdiction, organization, or person |
[props.site] | Reference | Specific Location |
[props.name] | string | Computer friendly designation |
[props.title] | string | Human Friendly name |
[props.subtitle] | string | Subordinate Friendly name |
[props.alias] | string | Acronym or short name |
[props.author] | Reference | Source of Contract |
[props.scope] | CodeableConcept | Range of Legal Concerns |
[props.topic] | CodeableConcept | Reference | Focus of contract interest |
[props.type] | CodeableConcept | Legal instrument category |
[props.subType] | CodeableConcept | Subtype within the context of type |
[props.contentDefinition] | BackboneElement | Contract precursor content |
[props.term] | BackboneElement | Contract Term List |
[props.supportingInfo] | Reference | Extra Information |
[props.relevantHistory] | Reference | Key event in Contract History |
[props.signer] | BackboneElement | Contract Signatory |
[props.friendly] | BackboneElement | Contract Friendly Language |
[props.legal] | BackboneElement | Contract Legal Language |
[props.rule] | BackboneElement | Computable Contract Language |
[props.legallyBinding] | Attachment | Reference | Binding Contract |
builders.coverage
coverage(type, props)
Create a FHIR Coverage resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Business Identifier for the coverage |
[props.status] | string | active |
[props.type] | CodeableConcept | Coverage category such as medical or accident |
[props.policyHolder] | Reference | Owner of the policy |
[props.subscriber] | Reference | Subscriber to the policy |
[props.subscriberId] | string | ID assigned to the subscriber |
[props.beneficiary] | Reference | Plan beneficiary |
[props.dependent] | string | Dependent number |
[props.relationship] | CodeableConcept | Beneficiary relationship to the subscriber |
[props.period] | Period | Coverage start and end dates |
[props.payor] | Reference | Issuer of the policy |
[props.class] | BackboneElement | Additional coverage classifications |
[props.order] | number | Relative order of the coverage |
[props.network] | string | Insurer network |
[props.costToBeneficiary] | BackboneElement | Patient payments for services/products |
[props.subrogation] | boolean | Reimbursement to insurer |
[props.contract] | Reference | Contract details |
builders.coverageEligibilityRequest
coverageEligibilityRequest(type, props)
Create a FHIR CoverageEligibilityRequest resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Business Identifier for coverage eligiblity request |
[props.status] | string | active |
[props.priority] | CodeableConcept | Desired processing priority |
[props.purpose] | string | auth-requirements |
[props.patient] | Reference | Intended recipient of products and services |
[props.serviced] | date | Period | Estimated date or dates of service |
[props.created] | dateTime | Creation date |
[props.enterer] | Reference | Author |
[props.provider] | Reference | Party responsible for the request |
[props.insurer] | Reference | Coverage issuer |
[props.facility] | Reference | Servicing facility |
[props.supportingInfo] | BackboneElement | Supporting information |
[props.insurance] | BackboneElement | Patient insurance information |
[props.item] | BackboneElement | Item to be evaluated for eligibiity |
builders.coverageEligibilityResponse
coverageEligibilityResponse(type, props)
Create a FHIR CoverageEligibilityResponse resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Business Identifier for coverage eligiblity request |
[props.status] | string | active |
[props.purpose] | string | auth-requirements |
[props.patient] | Reference | Intended recipient of products and services |
[props.serviced] | date | Period | Estimated date or dates of service |
[props.created] | dateTime | Response creation date |
[props.requestor] | Reference | Party responsible for the request |
[props.request] | Reference | Eligibility request reference |
[props.outcome] | string | queued |
[props.disposition] | string | Disposition Message |
[props.insurer] | Reference | Coverage issuer |
[props.insurance] | BackboneElement | Patient insurance information |
[props.preAuthRef] | string | Preauthorization reference |
[props.form] | CodeableConcept | Printed form identifier |
[props.error] | BackboneElement | Processing errors |
builders.detectedIssue
detectedIssue(type, props)
Create a FHIR DetectedIssue resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Unique id for the detected issue |
[props.status] | string | registered |
[props.code] | CodeableConcept | Issue Category, e.g. drug-drug, duplicate therapy, etc. |
[props.severity] | string | high |
[props.patient] | Reference | Associated patient |
[props.identified] | dateTime | Period | When identified |
[props.author] | Reference | The provider or device that identified the issue |
[props.implicated] | Reference | Problem resource |
[props.evidence] | BackboneElement | Supporting evidence |
[props.detail] | string | Description and context |
[props.reference] | string | Authority for issue |
[props.mitigation] | BackboneElement | Step taken to address |
builders.device
device(type, props)
Create a FHIR Device resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Instance identifier |
[props.definition] | Reference | The reference to the definition for the device |
[props.udiCarrier] | BackboneElement | Unique Device Identifier (UDI) Barcode string |
[props.status] | string | active |
[props.statusReason] | CodeableConcept | online |
[props.distinctIdentifier] | string | The distinct identification string |
[props.manufacturer] | string | Name of device manufacturer |
[props.manufactureDate] | dateTime | Date when the device was made |
[props.expirationDate] | dateTime | Date and time of expiry of this device (if applicable) |
[props.lotNumber] | string | Lot number of manufacture |
[props.serialNumber] | string | Serial number assigned by the manufacturer |
[props.deviceName] | BackboneElement | The name of the device as given by the manufacturer |
[props.modelNumber] | string | The manufacturer's model number for the device |
[props.partNumber] | string | The part number or catalog number of the device |
[props.type] | CodeableConcept | The kind or type of device |
[props.specialization] | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication |
[props.version] | BackboneElement | The actual design of the device or software version running on the device |
[props.property] | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties |
[props.patient] | Reference | Patient to whom Device is affixed |
[props.owner] | Reference | Organization responsible for device |
[props.contact] | ContactPoint | Details for human/organization for support |
[props.location] | Reference | Where the device is found |
[props.url] | string | Network address to contact device |
[props.note] | Annotation | Device notes and comments |
[props.safety] | CodeableConcept | Safety Characteristics of Device |
[props.parent] | Reference | The device that this device is attached to or is part of |
builders.deviceDefinition
deviceDefinition(type, props)
Create a FHIR DeviceDefinition resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Instance identifier |
[props.udiDeviceIdentifier] | BackboneElement | Unique Device Identifier (UDI) Barcode string |
[props.manufacturer] | string | Reference | Name of device manufacturer |
[props.deviceName] | BackboneElement | A name given to the device to identify it |
[props.modelNumber] | string | The model number for the device |
[props.type] | CodeableConcept | What kind of device or device system this is |
[props.specialization] | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication |
[props.version] | string | Available versions |
[props.safety] | CodeableConcept | Safety characteristics of the device |
[props.shelfLifeStorage] | ProductShelfLife | Shelf Life and storage information |
[props.physicalCharacteristics] | ProdCharacteristic | Dimensions, color etc. |
[props.languageCode] | CodeableConcept | Language code for the human-readable text strings produced by the device (all supported) |
[props.capability] | BackboneElement | Device capabilities |
[props.property] | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties |
[props.owner] | Reference | Organization responsible for device |
[props.contact] | ContactPoint | Details for human/organization for support |
[props.url] | string | Network address to contact device |
[props.onlineInformation] | string | Access to on-line information |
[props.note] | Annotation | Device notes and comments |
[props.quantity] | Quantity | The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product) |
[props.parentDevice] | Reference | The parent device it can be part of |
[props.material] | BackboneElement | A substance used to create the material(s) of which the device is made |
builders.deviceMetric
deviceMetric(type, props)
Create a FHIR DeviceMetric resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Instance identifier |
[props.type] | CodeableConcept | Identity of metric, for example Heart Rate or PEEP Setting |
[props.unit] | CodeableConcept | Unit of Measure for the Metric |
[props.source] | Reference | Describes the link to the source Device |
[props.parent] | Reference | Describes the link to the parent Device |
[props.operationalStatus] | string | on |
[props.color] | string | black |
[props.category] | string | measurement |
[props.measurementPeriod] | Timing | Describes the measurement repetition time |
[props.calibration] | BackboneElement | Describes the calibrations that have been performed or that are required to be performed |
builders.deviceRequest
deviceRequest(type, props)
Create a FHIR DeviceRequest resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | External Request identifier |
[props.instantiatesCanonical] | canonical | Instantiates FHIR protocol or definition |
[props.instantiatesUri] | string | Instantiates external protocol or definition |
[props.basedOn] | Reference | What request fulfills |
[props.priorRequest] | Reference | What request replaces |
[props.groupIdentifier] | Identifier | Identifier of composite request |
[props.status] | string | draft |
[props.intent] | string | proposal |
[props.priority] | string | routine |
[props.code] | Reference | CodeableConcept | Device requested |
[props.parameter] | BackboneElement | Device details |
[props.subject] | Reference | Focus of request |
[props.encounter] | Reference | Encounter motivating request |
[props.occurrence] | dateTime | Period | Timing | Desired time or schedule for use |
[props.authoredOn] | dateTime | When recorded |
[props.requester] | Reference | Who/what is requesting diagnostics |
[props.performerType] | CodeableConcept | Filler role |
[props.performer] | Reference | Requested Filler |
[props.reasonCode] | CodeableConcept | Coded Reason for request |
[props.reasonReference] | Reference | Linked Reason for request |
[props.insurance] | Reference | Associated insurance coverage |
[props.supportingInfo] | Reference | Additional clinical information |
[props.note] | Annotation | Notes or comments |
[props.relevantHistory] | Reference | Request provenance |
builders.deviceUseStatement
deviceUseStatement(type, props)
Create a FHIR DeviceUseStatement resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | External identifier for this record |
[props.basedOn] | Reference | Fulfills plan, proposal or order |
[props.status] | string | active |
[props.subject] | Reference | Patient using device |
[props.derivedFrom] | Reference | Supporting information |
[props.timing] | Timing | Period | dateTime | How often the device was used |
[props.recordedOn] | dateTime | When statement was recorded |
[props.source] | Reference | Who made the statement |
[props.device] | Reference | Reference to device used |
[props.reasonCode] | CodeableConcept | Why device was used |
[props.reasonReference] | Reference | Why was DeviceUseStatement performed? |
[props.bodySite] | CodeableConcept | Target body site |
[props.note] | Annotation | Addition details (comments, instructions) |
builders.diagnosticReport
diagnosticReport(type, props)
Create a FHIR DiagnosticReport resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |
[props.identifier] | Identifier | Business identifier for report |
[props.basedOn] | Reference | What was requested |
[props.status] | string | registered |
[props.category] | CodeableConcept | Service category |
[props.code] | CodeableConcept | Name/Code for this diagnostic report |
[props.subject] | Reference | The subject of the report - usually, but not always, the patient |
[props.encounter] | Reference | Health care event when test ordered |
[props.effective] | dateTime | Period | Clinically relevant time/time-period for report |
[props.issued] | instant | DateTime this version was made |
[props.performer] | Reference | Responsible Diagnostic Service |
[props.resultsInterpreter] | Reference | Primary result interpreter |
[props.specimen] | Reference | Specimens this report is based on |
[props.result] | Reference | Observations |
[props.imagingStudy] | Reference | Reference to full details of imaging associated with the diagnostic report |
[props.media] | BackboneElement | Key images associated with this report |
[props.conclusion] | string | Clinical conclusion (interpretation) of test results |
[props.conclusionCode] | CodeableConcept | Codes for the clinical conclusion of test results |
[props.presentedForm] | Attachment | Entire report as issued |
builders.domainResource
domainResource(type, props)
Create a FHIR DomainResource resource.
Param | Type | Description |
---|---|---|
type | string | The profile id for the resource variant. Optional. |
props | object | Properties to apply to the resource (includes common and custom properties). |