fhir-4@0.5.2

addToBundle(resources, [name])

create(resource)

createBundle([props])

delete(reference)

read(reference)

search(resourceType, options)

update(reference, resource)

uploadBundle(bundle)

This adaptor exports the following namespaced functions:

builders.account(props)

builders.activityDefinition(props)

builders.administrableProductDefinition(props)

builders.adverseEvent(props)

builders.allergyIntolerance(props)

builders.appointment(props)

builders.appointmentResponse(props)

builders.biologicallyDerivedProduct(props)

builders.bodyStructure(props)

builders.carePlan(props)

builders.careTeam(props)

builders.chargeItem(props)

builders.chargeItemDefinition(props)

builders.citation(props)

builders.claim(props)

builders.claimResponse(props)

builders.clinicalImpression(props)

builders.clinicalUseDefinition(props)

builders.communication(props)

builders.communicationRequest(props)

builders.contract(props)

builders.coverage(props)

builders.coverageEligibilityRequest(props)

builders.coverageEligibilityResponse(props)

builders.detectedIssue(props)

builders.device(props)

builders.deviceDefinition(props)

builders.deviceMetric(props)

builders.deviceRequest(props)

builders.deviceUseStatement(props)

builders.diagnosticReport(props)

builders.domainResource(props)

builders.encounter(props)

builders.enrollmentRequest(props)

builders.enrollmentResponse(props)

builders.episodeOfCare(props)

builders.eventDefinition(props)

builders.evidence(props)

builders.evidenceReport(props)

builders.evidenceVariable(props)

builders.explanationOfBenefit(props)

builders.familyMemberHistory(props)

builders.flag(props)

builders.goal(props)

builders.group(props)

builders.guidanceResponse(props)

builders.healthcareService(props)

builders.imagingStudy(props)

builders.immunization(props)

builders.immunizationEvaluation(props)

builders.immunizationRecommendation(props)

builders.ingredient(props)

builders.insurancePlan(props)

builders.invoice(props)

builders.library(props)

builders.list(props)

builders.location(props)

builders.manufacturedItemDefinition(props)

builders.measure(props)

builders.measureReport(props)

builders.media(props)

builders.medication(props)

builders.medicationAdministration(props)

builders.medicationDispense(props)

builders.medicationKnowledge(props)

builders.medicationRequest(props)

builders.medicationStatement(props)

builders.medicinalProductDefinition(props)

builders.molecularSequence(props)

builders.nutritionOrder(props)

builders.nutritionProduct(props)

builders.observation(props)

builders.observationDefinition(props)

builders.organization(props)

builders.organizationAffiliation(props)

builders.packagedProductDefinition(props)

builders.patient(props)

builders.paymentNotice(props)

builders.paymentReconciliation(props)

builders.person(props)

builders.planDefinition(props)

builders.practitioner(props)

builders.practitionerRole(props)

builders.procedure(props)

builders.questionnaire(props)

builders.questionnaireResponse(props)

builders.regulatedAuthorization(props)

builders.relatedPerson(props)

builders.requestGroup(props)

builders.researchDefinition(props)

builders.researchElementDefinition(props)

builders.researchStudy(props)

builders.researchSubject(props)

builders.riskAssessment(props)

builders.schedule(props)

builders.serviceRequest(props)

builders.slot(props)

builders.specimen(props)

builders.specimenDefinition(props)

builders.substance(props)

builders.substanceDefinition(props)

builders.supplyDelivery(props)

builders.supplyRequest(props)

builders.task(props)

builders.testReport(props)

builders.verificationResult(props)

builders.visionPrescription(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)

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" },
}))

---

createBundle

createBundle([props]) ⇒

Generate a new bundle on state. Any existing bundle with the same name will be overwritten.

Returns: Operation

Param	Type	Description
[options.name]	string	A name (key) for this bundle on state (defaults to bundle)
[options.type]	string	The type of this bundle. Accepts document
[props]	object	Assign any arbitrary properties to the bundle object

This operation writes the following keys to state:

State Key	Description
(name)	the updated bundle

Example: Create a default bundle and add an item

createBundle()
addToBundle($.patient)

Example: Create a batch-type bundle called 'upload'

createBundle({ name: 'upload', type: 'batch' })

Example: Create a bundle with custom properties

createBundle({}, { timestamp: new Date().toISOString() }})
* @example <caption>Create a named bundle and add an item</caption>
createBundle({ name: 'upload')
addToBundle($.patient, 'upload')

---

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(props)

Create a Account resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[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.description]	string	Explanation of purpose/use
[props.guarantor]	BackboneElement	The parties ultimately responsible for balancing the Account
[props.identifier]	Identifier	Account number
[props.name]	string	Human-readable label
[props.owner]	Reference	Entity managing the Account
[props.partOf]	Reference	Reference to a parent Account
[props.servicePeriod]	Period	Transaction window
[props.status]	string	active
[props.subject]	Reference	The entity that caused the expenses
[props.type]	string	E.g. patient, expense, depreciation. Accepts all values from http://hl7.org/fhir/ValueSet/account-type

---

builders.activityDefinition

activityDefinition(props)

Create a ActivityDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.approvalDate]	date	When the activity definition was approved by publisher
[props.author]	ContactDetail	Who authored the content
[props.bodySite]	string	What part of body to perform on. Accepts all values from http://hl7.org/fhir/ValueSet/body-site
[props.code]	string	Detail type of activity. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-code
[props.contact]	ContactDetail	Contact details for the publisher
[props.copyright]	markdown	Use and/or publishing restrictions
[props.date]	dateTime	Date last changed
[props.description]	markdown	Natural language description of the activity definition
[props.doNotPerform]	boolean	True if the activity should not be performed
[props.dosage]	Dosage	Detailed dosage instructions
[props.dynamicValue]	BackboneElement	Dynamic aspects of the definition
[props.editor]	ContactDetail	Who edited the content
[props.effectivePeriod]	Period	When the activity definition is expected to be used
[props.endorser]	ContactDetail	Who endorsed the content
[props.experimental]	boolean	For testing purposes, not real usage
[props.identifier]	Identifier	Additional identifier for the activity definition
[props.intent]	string	proposal
[props.jurisdiction]	string	Intended jurisdiction for activity definition (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.kind]	string	Kind of resource. Accepts all values from http://hl7.org/fhir/ValueSet/request-resource-types
[props.lastReviewDate]	date	When the activity definition was last reviewed
[props.library]	canonical	Logic used by the activity definition
[props.location]	Reference	Where it should happen
[props.name]	string	Name for this activity definition (computer friendly)
[props.observationRequirement]	Reference	What observations are required to perform this action
[props.observationResultRequirement]	Reference	What observations must be produced by this action
[props.participant]	BackboneElement	Who should participate in the action
[props.priority]	string	routine
[props.product]	string	What's administered/supplied. Accepts all values from http://hl7.org/fhir/ValueSet/medication-codes
[props.profile]	canonical	What profile the resource needs to conform to
[props.publisher]	string	Name of the publisher (organization or individual)
[props.purpose]	markdown	Why this activity definition is defined
[props.quantity]	Quantity	How much is administered/consumed/supplied
[props.relatedArtifact]	RelatedArtifact	Additional documentation, citations, etc.
[props.reviewer]	ContactDetail	Who reviewed the content
[props.specimenRequirement]	Reference	What specimens are required to perform this action
[props.status]	string	draft
[props.subject]	string	Type of individual the activity definition is intended for. Accepts all values from http://hl7.org/fhir/ValueSet/subject-type
[props.subtitle]	string	Subordinate title of the activity definition
[props.timing]	Timing | dateTime | Age | Period | Range | Duration	When activity is to occur
[props.title]	string	Name for this activity definition (human friendly)
[props.topic]	string	E.g. Education, Treatment, Assessment, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/definition-topic
[props.transform]	canonical	Transform to apply the template
[props.url]	string	Canonical identifier for this activity definition, represented as a URI (globally unique)
[props.usage]	string	Describes the clinical usage of the activity definition
[props.useContext]	UsageContext	The context that the content is intended to support
[props.version]	string	Business version of the activity definition

---

builders.administrableProductDefinition

administrableProductDefinition(props)

Create a AdministrableProductDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.administrableDoseForm]	string	The dose form of the final product after necessary reconstitution or processing. Accepts all values from http://hl7.org/fhir/ValueSet/administrable-dose-form
[props.device]	Reference	A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
[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.identifier]	Identifier	An identifier for the administrable product
[props.ingredient]	string	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. Accepts all values from http://hl7.org/fhir/ValueSet/substance-codes
[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.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
[props.status]	string	draft
[props.unitOfPresentation]	string	The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'. Accepts all values from http://hl7.org/fhir/ValueSet/unit-of-presentation

---

builders.adverseEvent

adverseEvent(props)

Create a AdverseEvent resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.actuality]	string	actual
[props.category]	string	product-problem
[props.contributor]	Reference	Who was involved in the adverse event or the potential adverse event
[props.date]	dateTime	When the event occurred
[props.detected]	dateTime	When the event was detected
[props.encounter]	Reference	Encounter created as part of
[props.event]	string	Type of the event itself in relation to the subject. Accepts all values from http://hl7.org/fhir/ValueSet/adverse-event-type
[props.identifier]	Identifier	Business identifier for the event
[props.location]	Reference	Location where adverse event occurred
[props.outcome]	string	resolved
[props.recordedDate]	dateTime	When the event was recorded
[props.recorder]	Reference	Who recorded the adverse event
[props.referenceDocument]	Reference	AdverseEvent.referenceDocument
[props.resultingCondition]	Reference	Effect on the subject due to this event
[props.seriousness]	string	Seriousness of the event. Accepts all values from http://hl7.org/fhir/ValueSet/adverse-event-seriousness
[props.severity]	string	mild
[props.study]	Reference	AdverseEvent.study
[props.subject]	Reference	Subject impacted by event
[props.subjectMedicalHistory]	Reference	AdverseEvent.subjectMedicalHistory
[props.suspectEntity]	BackboneElement	The suspected agent causing the adverse event

---

builders.allergyIntolerance

allergyIntolerance(props)

Create a AllergyIntolerance resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.asserter]	Reference	Source of the information about the allergy
[props.category]	string	food
[props.clinicalStatus]	string	active
[props.code]	string	Code that identifies the allergy or intolerance. Accepts all values from http://hl7.org/fhir/ValueSet/allergyintolerance-code
[props.criticality]	string	low
[props.encounter]	Reference	Encounter when the allergy or intolerance was asserted
[props.identifier]	Identifier	External ids for this item
[props.lastOccurrence]	dateTime	Date(/time) of last known occurrence of a reaction
[props.note]	Annotation	Additional text not captured in other fields
[props.onset]	dateTime | Age | Period | Range | string	When allergy or intolerance was identified
[props.patient]	Reference	Who the sensitivity is for
[props.reaction]	BackboneElement	Adverse Reaction Events linked to exposure to substance
[props.recordedDate]	dateTime	Date first version of the resource instance was recorded
[props.recorder]	Reference	Who recorded the sensitivity
[props.type]	string	allergy
[props.verificationStatus]	string	unconfirmed

---

builders.appointment

appointment(props)

Create a Appointment resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.appointmentType]	string	The style of appointment or patient that has been booked in the slot (not service type). Accepts all values from http://terminology.hl7.org/ValueSet/v2-0276
[props.basedOn]	Reference	The service request this appointment is allocated to assess
[props.cancelationReason]	string	The coded reason for the appointment being cancelled. Accepts all values from http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
[props.comment]	string	Additional comments
[props.created]	dateTime	The date that this appointment was initially created
[props.description]	string	Shown on a subject line in a meeting request, or appointment list
[props.end]	instant	When appointment is to conclude
[props.identifier]	Identifier	External Ids for this item
[props.minutesDuration]	number	Can be less than start/end (e.g. estimate)
[props.participant]	BackboneElement	Participants involved in appointment
[props.patientInstruction]	string	Detailed information and instructions for the patient
[props.priority]	unsignedInt	Used to make informed decisions if needing to re-prioritize
[props.reasonCode]	string	Coded reason this appointment is scheduled. Accepts all values from http://hl7.org/fhir/ValueSet/encounter-reason
[props.reasonReference]	Reference	Reason the appointment is to take place (resource)
[props.requestedPeriod]	Period	Potential date/time interval(s) requested to allocate the appointment within
[props.serviceCategory]	string	A broad categorization of the service that is to be performed during this appointment. Accepts all values from http://hl7.org/fhir/ValueSet/service-category
[props.serviceType]	string	The specific service that is to be performed during this appointment. Accepts all values from http://hl7.org/fhir/ValueSet/service-type
[props.slot]	Reference	The slots that this appointment is filling
[props.specialty]	string	The specialty of a practitioner that would be required to perform the service requested in this appointment. Accepts all values from http://hl7.org/fhir/ValueSet/c80-practice-codes
[props.start]	instant	When appointment is to take place
[props.status]	string	proposed
[props.supportingInformation]	Reference	Additional information to support the appointment

---

builders.appointmentResponse

appointmentResponse(props)

Create a AppointmentResponse resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.actor]	Reference	Person, Location, HealthcareService, or Device
[props.appointment]	Reference	Appointment this response relates to
[props.comment]	string	Additional comments
[props.end]	instant	Time from appointment, or requested new end time
[props.identifier]	Identifier	External Ids for this item
[props.participantStatus]	string	accepted
[props.participantType]	string	Role of participant in the appointment. Accepts all values from http://hl7.org/fhir/ValueSet/encounter-participant-type
[props.start]	instant	Time from appointment, or requested new start time

---

builders.biologicallyDerivedProduct

biologicallyDerivedProduct(props)

Create a BiologicallyDerivedProduct resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.collection]	BackboneElement	How this product was collected
[props.identifier]	Identifier	External ids for this item
[props.manipulation]	BackboneElement	Any manipulation of product post-collection
[props.parent]	Reference	BiologicallyDerivedProduct parent
[props.processing]	BackboneElement	Any processing of the product during collection
[props.productCategory]	string	organ
[props.productCode]	CodeableConcept	What this biologically derived product is
[props.quantity]	integer	The amount of this biologically derived product
[props.request]	Reference	Procedure request
[props.status]	string	available
[props.storage]	BackboneElement	Product storage

---

builders.bodyStructure

bodyStructure(props)

Create a BodyStructure resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.active]	boolean	Whether this record is in active use
[props.description]	string	Text description
[props.identifier]	Identifier	Bodystructure identifier
[props.image]	Attachment	Attached images
[props.location]	string	Body site. Accepts all values from http://hl7.org/fhir/ValueSet/body-site
[props.locationQualifier]	string	Body site modifier. Accepts all values from http://hl7.org/fhir/ValueSet/bodystructure-relative-location
[props.morphology]	string	Kind of Structure. Accepts all values from http://hl7.org/fhir/ValueSet/bodystructure-code
[props.patient]	Reference	Who this is about

---

builders.carePlan

carePlan(props)

Create a CarePlan resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.activity]	BackboneElement	Action to occur as part of plan
[props.addresses]	Reference	Health issues this plan addresses
[props.author]	Reference	Who is the designated responsible party
[props.basedOn]	Reference	Fulfills CarePlan
[props.careTeam]	Reference	Who's involved in plan?
[props.category]	string	Type of plan. Accepts all values from http://hl7.org/fhir/ValueSet/care-plan-category
[props.contributor]	Reference	Who provided the content of the care plan
[props.created]	dateTime	Date record was first recorded
[props.description]	string	Summary of nature of plan
[props.encounter]	Reference	Encounter created as part of
[props.goal]	Reference	Desired outcome of plan
[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.intent]	string	proposal
[props.note]	Annotation	Comments about the plan
[props.partOf]	Reference	Part of referenced CarePlan
[props.period]	Period	Time period plan covers
[props.replaces]	Reference	CarePlan replaced by this CarePlan
[props.status]	string	draft
[props.subject]	Reference	Who the care plan is for
[props.supportingInfo]	Reference	Information considered as part of plan
[props.title]	string	Human-friendly name for the care plan

---

builders.careTeam

careTeam(props)

Create a CareTeam resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.category]	string	Type of team. Accepts all values from http://hl7.org/fhir/ValueSet/care-team-category
[props.encounter]	Reference	Encounter created as part of
[props.identifier]	Identifier	External Ids for this team
[props.managingOrganization]	Reference	Organization responsible for the care team
[props.name]	string	Name of the team, such as crisis assessment team
[props.note]	Annotation	Comments made about the CareTeam
[props.participant]	BackboneElement	Members of the team
[props.period]	Period	Time period team covers
[props.reasonCode]	string	Why the care team exists. Accepts all values from http://hl7.org/fhir/ValueSet/clinical-findings
[props.reasonReference]	Reference	Why the care team exists
[props.status]	string	proposed
[props.subject]	Reference	Who care team is for
[props.telecom]	ContactPoint	A contact detail for the care team (that applies to all members)

---

builders.chargeItem

chargeItem(props)

Create a ChargeItem resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.account]	Reference	Account to place this charge
[props.bodysite]	string	Anatomical location, if relevant. Accepts all values from http://hl7.org/fhir/ValueSet/body-site
[props.code]	string	A code that identifies the charge, like a billing code. Accepts all values from http://hl7.org/fhir/ValueSet/chargeitem-billingcodes
[props.context]	Reference	Encounter / Episode associated with event
[props.costCenter]	Reference	Organization that has ownership of the (potential, future) revenue
[props.definitionCanonical]	canonical	Resource defining the code of this ChargeItem
[props.definitionUri]	string	Defining information about the code of this charge item
[props.enteredDate]	dateTime	Date the charge item was entered
[props.enterer]	Reference	Individual who was entering
[props.factorOverride]	decimal	Factor overriding the associated rules
[props.identifier]	Identifier	Business Identifier for item
[props.note]	Annotation	Comments made about the ChargeItem
[props.occurrence]	dateTime | Period | Timing	When the charged service was applied
[props.overrideReason]	string	Reason for overriding the list price/factor
[props.partOf]	Reference	Part of referenced ChargeItem
[props.performer]	BackboneElement	Who performed charged service
[props.performingOrganization]	Reference	Organization providing the charged service
[props.priceOverride]	Money	Price overriding the associated rules
[props.product]	string	Product charged. Accepts all values from http://hl7.org/fhir/ValueSet/device-kind
[props.quantity]	Quantity	Quantity of which the charge item has been serviced
[props.reason]	string	Why was the charged service rendered?. Accepts all values from http://hl7.org/fhir/ValueSet/icd-10
[props.requestingOrganization]	Reference	Organization requesting the charged service
[props.service]	Reference	Which rendered service is being charged?
[props.status]	string	planned
[props.subject]	Reference	Individual service was done for/to
[props.supportingInformation]	Reference	Further information supporting this charge

---

builders.chargeItemDefinition

chargeItemDefinition(props)

Create a ChargeItemDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.applicability]	BackboneElement	Whether or not the billing code is applicable
[props.approvalDate]	date	When the charge item definition was approved by publisher
[props.code]	string	Billing codes or product types this definition applies to. Accepts all values from http://hl7.org/fhir/ValueSet/chargeitem-billingcodes
[props.contact]	ContactDetail	Contact details for the publisher
[props.copyright]	markdown	Use and/or publishing restrictions
[props.date]	dateTime	Date last changed
[props.derivedFromUri]	string	Underlying externally-defined charge item definition
[props.description]	markdown	Natural language description of the charge item definition
[props.effectivePeriod]	Period	When the charge item definition is expected to be used
[props.experimental]	boolean	For testing purposes, not real usage
[props.identifier]	Identifier	Additional identifier for the charge item definition
[props.instance]	Reference	Instances this definition applies to
[props.jurisdiction]	string	Intended jurisdiction for charge item definition (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.lastReviewDate]	date	When the charge item definition was last reviewed
[props.partOf]	canonical	A larger definition of which this particular definition is a component or step
[props.propertyGroup]	BackboneElement	Group of properties which are applicable under the same conditions
[props.publisher]	string	Name of the publisher (organization or individual)
[props.replaces]	canonical	Completed or terminated request(s) whose function is taken by this new request
[props.status]	string	draft
[props.title]	string	Name for this charge item definition (human friendly)
[props.url]	string	Canonical identifier for this charge item definition, represented as a URI (globally unique)
[props.useContext]	UsageContext	The context that the content is intended to support
[props.version]	string	Business version of the charge item definition

---

builders.citation

citation(props)

Create a Citation resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.approvalDate]	date	When the citation was approved by publisher
[props.author]	ContactDetail	Who authored the Citation
[props.citedArtifact]	BackboneElement	The article or artifact being described
[props.classification]	BackboneElement	The assignment to an organizing scheme
[props.contact]	ContactDetail	Contact details for the publisher of the Citation Resource
[props.copyright]	markdown	Use and/or publishing restrictions for the Citation, not for the cited artifact
[props.currentState]	string	The status of the citation. Accepts all values from http://hl7.org/fhir/ValueSet/citation-status-type
[props.date]	dateTime	Date last changed
[props.description]	markdown	Natural language description of the citation
[props.editor]	ContactDetail	Who edited the Citation
[props.effectivePeriod]	Period	When the citation is expected to be used
[props.endorser]	ContactDetail	Who endorsed the Citation
[props.experimental]	boolean	For testing purposes, not real usage
[props.identifier]	Identifier	Identifier for the Citation resource itself
[props.jurisdiction]	string	Intended jurisdiction for citation (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.lastReviewDate]	date	When the citation was last reviewed
[props.name]	string	Name for this citation (computer friendly)
[props.note]	Annotation	Used for general notes and annotations not coded elsewhere
[props.publisher]	string	The publisher of the Citation, not the publisher of the article or artifact being cited
[props.purpose]	markdown	Why this citation is defined
[props.relatesTo]	BackboneElement	Artifact related to the Citation Resource
[props.reviewer]	ContactDetail	Who reviewed the Citation
[props.status]	string	draft
[props.statusDate]	BackboneElement	An effective date or period for a status of the citation
[props.summary]	BackboneElement	A human-readable display of the citation
[props.title]	string	Name for this citation (human friendly)
[props.url]	string	Canonical identifier for this citation, represented as a globally unique URI
[props.useContext]	UsageContext	The context that the Citation Resource content is intended to support
[props.version]	string	Business version of the citation

---

builders.claim

claim(props)

Create a Claim resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.accident]	BackboneElement	Details of the event
[props.billablePeriod]	Period	Relevant time frame for the claim
[props.careTeam]	BackboneElement	Members of the care team
[props.created]	dateTime	Resource creation date
[props.diagnosis]	BackboneElement	Pertinent diagnosis information
[props.enterer]	Reference	Author of the claim
[props.facility]	Reference	Servicing facility
[props.fundsReserve]	string	For whom to reserve funds. Accepts all values from http://hl7.org/fhir/ValueSet/fundsreserve
[props.identifier]	Identifier	Business Identifier for claim
[props.insurance]	BackboneElement	Patient insurance information
[props.insurer]	Reference	Target
[props.item]	BackboneElement	Product or service provided
[props.originalPrescription]	Reference	Original prescription if superseded by fulfiller
[props.patient]	Reference	The recipient of the products and services
[props.payee]	BackboneElement	Recipient of benefits payable
[props.prescription]	Reference	Prescription authorizing services and products
[props.priority]	string	Desired processing ugency. Accepts all values from http://hl7.org/fhir/ValueSet/process-priority
[props.procedure]	BackboneElement	Clinical procedures performed
[props.provider]	Reference	Party responsible for the claim
[props.referral]	Reference	Treatment referral
[props.related]	BackboneElement	Prior or corollary claims
[props.status]	string	active
[props.subType]	string	More granular claim type. Accepts all values from http://hl7.org/fhir/ValueSet/claim-subtype
[props.supportingInfo]	BackboneElement	Supporting information
[props.total]	Money	Total claim cost
[props.type]	string	Category or discipline. Accepts all values from http://hl7.org/fhir/ValueSet/claim-type
[props.use]	string	claim

---

builders.claimResponse

claimResponse(props)

Create a ClaimResponse resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.addItem]	BackboneElement	Insurer added line items
[props.adjudication]	any	Header-level adjudication
[props.communicationRequest]	Reference	Request for additional information
[props.created]	dateTime	Response creation date
[props.disposition]	string	Disposition Message
[props.error]	BackboneElement	Processing errors
[props.form]	Attachment	Printed reference or actual form
[props.formCode]	string	Printed form identifier. Accepts all values from http://hl7.org/fhir/ValueSet/forms
[props.fundsReserve]	string	Funds reserved status. Accepts all values from http://hl7.org/fhir/ValueSet/fundsreserve
[props.identifier]	Identifier	Business Identifier for a claim response
[props.insurance]	BackboneElement	Patient insurance information
[props.insurer]	Reference	Party responsible for reimbursement
[props.item]	BackboneElement	Adjudication for claim line items
[props.outcome]	string	queued
[props.patient]	Reference	The recipient of the products and services
[props.payeeType]	string	Party to be paid any benefits payable. Accepts all values from http://hl7.org/fhir/ValueSet/payeetype
[props.payment]	BackboneElement	Payment Details
[props.preAuthPeriod]	Period	Preauthorization reference effective period
[props.preAuthRef]	string	Preauthorization reference
[props.processNote]	BackboneElement	Note concerning adjudication
[props.request]	Reference	Id of resource triggering adjudication
[props.requestor]	Reference	Party responsible for the claim
[props.status]	string	active
[props.subType]	string	More granular claim type. Accepts all values from http://hl7.org/fhir/ValueSet/claim-subtype
[props.total]	BackboneElement	Adjudication totals
[props.type]	string	More granular claim type. Accepts all values from http://hl7.org/fhir/ValueSet/claim-type
[props.use]	string	claim

---

builders.clinicalImpression

clinicalImpression(props)

Create a ClinicalImpression resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.assessor]	Reference	The clinician performing the assessment
[props.code]	CodeableConcept	Kind of assessment performed
[props.date]	dateTime	When the assessment was documented
[props.description]	string	Why/how the assessment was performed
[props.effective]	dateTime | Period	Time of assessment
[props.encounter]	Reference	Encounter created as part of
[props.finding]	BackboneElement	Possible or likely findings and diagnoses
[props.identifier]	Identifier	Business identifier
[props.investigation]	BackboneElement	One or more sets of investigations (signs, symptoms, etc.)
[props.note]	Annotation	Comments made about the ClinicalImpression
[props.previous]	Reference	Reference to last assessment
[props.problem]	Reference	Relevant impressions of patient state
[props.prognosisCodeableConcept]	string	Estimate of likely outcome. Accepts all values from http://hl7.org/fhir/ValueSet/clinicalimpression-prognosis
[props.prognosisReference]	Reference	RiskAssessment expressing likely outcome
[props.protocol]	string	Clinical Protocol followed
[props.status]	string	in-progress
[props.statusReason]	CodeableConcept	Reason for current status
[props.subject]	Reference	Patient or group assessed
[props.summary]	string	Summary of the assessment
[props.supportingInfo]	Reference	Information supporting the clinical impression

---

builders.clinicalUseDefinition

clinicalUseDefinition(props)

Create a ClinicalUseDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.category]	string	A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose". Accepts all values from http://hl7.org/fhir/ValueSet/clinical-use-definition-category
[props.contraindication]	BackboneElement	Specifics for when this is a contraindication
[props.identifier]	Identifier	Business identifier for this issue
[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.status]	string	Whether this is a current issue or one that has been retired etc. Accepts all values from http://hl7.org/fhir/ValueSet/publication-status
[props.subject]	Reference	The medication or procedure for which this is an indication
[props.type]	string	indication
[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(props)

Create a Communication resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.about]	Reference	Resources that pertain to this communication
[props.basedOn]	Reference	Request fulfilled by this communication
[props.category]	string	Message category. Accepts all values from http://hl7.org/fhir/ValueSet/communication-category
[props.encounter]	Reference	Encounter created as part of
[props.identifier]	Identifier	Unique identifier
[props.inResponseTo]	Reference	Reply to
[props.instantiatesCanonical]	canonical	Instantiates FHIR protocol or definition
[props.instantiatesUri]	string	Instantiates external protocol or definition
[props.medium]	string	A channel of communication. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ParticipationMode
[props.note]	Annotation	Comments made about the communication
[props.partOf]	Reference	Part of this action
[props.payload]	BackboneElement	Message payload
[props.priority]	string	routine
[props.reasonCode]	string	Indication for message. Accepts all values from http://hl7.org/fhir/ValueSet/clinical-findings
[props.reasonReference]	Reference	Why was communication done?
[props.received]	dateTime	When received
[props.recipient]	Reference	Message recipient
[props.sender]	Reference	Message sender
[props.sent]	dateTime	When sent
[props.status]	string	preparation
[props.statusReason]	string	Reason for current status. Accepts all values from http://hl7.org/fhir/ValueSet/communication-not-done-reason
[props.subject]	Reference	Focus of message
[props.topic]	string	Description of the purpose/content. Accepts all values from http://hl7.org/fhir/ValueSet/communication-topic

---

builders.communicationRequest

communicationRequest(props)

Create a CommunicationRequest resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.about]	Reference	Resources that pertain to this communication request
[props.authoredOn]	dateTime	When request transitioned to being actionable
[props.basedOn]	Reference	Fulfills plan or proposal
[props.category]	string	Message category. Accepts all values from http://hl7.org/fhir/ValueSet/communication-category
[props.doNotPerform]	boolean	True if request is prohibiting action
[props.encounter]	Reference	Encounter created as part of
[props.groupIdentifier]	Identifier	Composite request this is part of
[props.identifier]	Identifier	Unique identifier
[props.medium]	string	A channel of communication. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ParticipationMode
[props.note]	Annotation	Comments made about communication request
[props.occurrence]	dateTime | Period	When scheduled
[props.payload]	BackboneElement	Message payload
[props.priority]	string	routine
[props.reasonCode]	string	Why is communication needed?. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ActReason
[props.reasonReference]	Reference	Why is communication needed?
[props.recipient]	Reference	Message recipient
[props.replaces]	Reference	Request(s) replaced by this request
[props.requester]	Reference	Who/what is requesting service
[props.sender]	Reference	Message sender
[props.status]	string	draft
[props.statusReason]	CodeableConcept	Reason for current status
[props.subject]	Reference	Focus of message

---

builders.contract

contract(props)

Create a Contract resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.alias]	string	Acronym or short name
[props.applies]	Period	Effective time
[props.author]	Reference	Source of Contract
[props.authority]	Reference	Authority under which this Contract has standing
[props.contentDefinition]	BackboneElement	Contract precursor content
[props.contentDerivative]	string	Content derived from the basal information. Accepts all values from http://hl7.org/fhir/ValueSet/contract-content-derivative
[props.domain]	Reference	A sphere of control governed by an authoritative jurisdiction, organization, or person
[props.expirationType]	string	Contract cessation cause. Accepts all values from http://hl7.org/fhir/ValueSet/contract-expiration-type
[props.friendly]	BackboneElement	Contract Friendly Language
[props.identifier]	Identifier	Contract number
[props.instantiatesCanonical]	Reference	Source Contract Definition
[props.instantiatesUri]	string	External Contract Definition
[props.issued]	dateTime	When this Contract was issued
[props.legal]	BackboneElement	Contract Legal Language
[props.legalState]	string	Negotiation status. Accepts all values from http://hl7.org/fhir/ValueSet/contract-legalstate
[props.legallyBinding]	Attachment | Reference	Binding Contract
[props.name]	string	Computer friendly designation
[props.relevantHistory]	Reference	Key event in Contract History
[props.rule]	BackboneElement	Computable Contract Language
[props.scope]	string	Range of Legal Concerns. Accepts all values from http://hl7.org/fhir/ValueSet/contract-scope
[props.signer]	BackboneElement	Contract Signatory
[props.site]	Reference	Specific Location
[props.status]	string	amended
[props.subType]	string	Subtype within the context of type. Accepts all values from http://hl7.org/fhir/ValueSet/contract-subtype
[props.subject]	Reference	Contract Target Entity
[props.subtitle]	string	Subordinate Friendly name
[props.supportingInfo]	Reference	Extra Information
[props.term]	BackboneElement	Contract Term List
[props.title]	string	Human Friendly name
[props.topic]	CodeableConcept | Reference	Focus of contract interest
[props.type]	string	Legal instrument category. Accepts all values from http://hl7.org/fhir/ValueSet/contract-type
[props.url]	string	Basal definition
[props.version]	string	Business edition

---

builders.coverage

coverage(props)

Create a Coverage resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.beneficiary]	Reference	Plan beneficiary
[props.class]	BackboneElement	Additional coverage classifications
[props.contract]	Reference	Contract details
[props.costToBeneficiary]	BackboneElement	Patient payments for services/products
[props.dependent]	string	Dependent number
[props.identifier]	Identifier	Business Identifier for the coverage
[props.network]	string	Insurer network
[props.order]	number	Relative order of the coverage
[props.payor]	Reference	Issuer of the policy
[props.period]	Period	Coverage start and end dates
[props.policyHolder]	Reference	Owner of the policy
[props.relationship]	string	Beneficiary relationship to the subscriber. Accepts all values from http://hl7.org/fhir/ValueSet/subscriber-relationship
[props.status]	string	active
[props.subrogation]	boolean	Reimbursement to insurer
[props.subscriber]	Reference	Subscriber to the policy
[props.subscriberId]	string	ID assigned to the subscriber
[props.type]	string	Coverage category such as medical or accident. Accepts all values from http://hl7.org/fhir/ValueSet/coverage-type

---

builders.coverageEligibilityRequest

coverageEligibilityRequest(props)

Create a CoverageEligibilityRequest resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.created]	dateTime	Creation date
[props.enterer]	Reference	Author
[props.facility]	Reference	Servicing facility
[props.identifier]	Identifier	Business Identifier for coverage eligiblity request
[props.insurance]	BackboneElement	Patient insurance information
[props.insurer]	Reference	Coverage issuer
[props.item]	BackboneElement	Item to be evaluated for eligibiity
[props.patient]	Reference	Intended recipient of products and services
[props.priority]	string	Desired processing priority. Accepts all values from http://hl7.org/fhir/ValueSet/process-priority
[props.provider]	Reference	Party responsible for the request
[props.purpose]	string	auth-requirements
[props.serviced]	date | Period	Estimated date or dates of service
[props.status]	string	active
[props.supportingInfo]	BackboneElement	Supporting information

---

builders.coverageEligibilityResponse

coverageEligibilityResponse(props)

Create a CoverageEligibilityResponse resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.created]	dateTime	Response creation date
[props.disposition]	string	Disposition Message
[props.error]	BackboneElement	Processing errors
[props.form]	string	Printed form identifier. Accepts all values from http://hl7.org/fhir/ValueSet/forms
[props.identifier]	Identifier	Business Identifier for coverage eligiblity request
[props.insurance]	BackboneElement	Patient insurance information
[props.insurer]	Reference	Coverage issuer
[props.outcome]	string	queued
[props.patient]	Reference	Intended recipient of products and services
[props.preAuthRef]	string	Preauthorization reference
[props.purpose]	string	auth-requirements
[props.request]	Reference	Eligibility request reference
[props.requestor]	Reference	Party responsible for the request
[props.serviced]	date | Period	Estimated date or dates of service
[props.status]	string	active

---

builders.detectedIssue

detectedIssue(props)

Create a DetectedIssue resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.author]	Reference	The provider or device that identified the issue
[props.code]	string	Issue Category, e.g. drug-drug, duplicate therapy, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/detectedissue-category
[props.detail]	string	Description and context
[props.evidence]	BackboneElement	Supporting evidence
[props.identified]	dateTime | Period	When identified
[props.identifier]	Identifier	Unique id for the detected issue
[props.implicated]	Reference	Problem resource
[props.mitigation]	BackboneElement	Step taken to address
[props.patient]	Reference	Associated patient
[props.reference]	string	Authority for issue
[props.severity]	string	high
[props.status]	string	registered

---

builders.device

device(props)

Create a Device resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.contact]	ContactPoint	Details for human/organization for support
[props.definition]	Reference	The reference to the definition for the device
[props.deviceName]	BackboneElement	The name of the device as given by the manufacturer
[props.distinctIdentifier]	string	The distinct identification string
[props.expirationDate]	dateTime	Date and time of expiry of this device (if applicable)
[props.identifier]	Identifier	Instance identifier
[props.location]	Reference	Where the device is found
[props.lotNumber]	string	Lot number of manufacture
[props.manufactureDate]	dateTime	Date when the device was made
[props.manufacturer]	string	Name of device manufacturer
[props.modelNumber]	string	The manufacturer's model number for the device
[props.note]	Annotation	Device notes and comments
[props.owner]	Reference	Organization responsible for device
[props.parent]	Reference	The device that this device is attached to or is part of
[props.partNumber]	string	The part number or catalog number of the device
[props.patient]	Reference	Patient to whom Device is affixed
[props.property]	BackboneElement	The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
[props.safety]	CodeableConcept	Safety Characteristics of Device
[props.serialNumber]	string	Serial number assigned by the manufacturer
[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.status]	string	active
[props.statusReason]	string	online
[props.type]	string	The kind or type of device. Accepts all values from http://hl7.org/fhir/ValueSet/device-type
[props.udiCarrier]	BackboneElement	Unique Device Identifier (UDI) Barcode string
[props.url]	string	Network address to contact device
[props.version]	BackboneElement	The actual design of the device or software version running on the device

---

builders.deviceDefinition

deviceDefinition(props)

Create a DeviceDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.capability]	BackboneElement	Device capabilities
[props.contact]	ContactPoint	Details for human/organization for support
[props.deviceName]	BackboneElement	A name given to the device to identify it
[props.identifier]	Identifier	Instance identifier
[props.languageCode]	CodeableConcept	Language code for the human-readable text strings produced by the device (all supported)
[props.manufacturer]	string | Reference	Name of device manufacturer
[props.material]	BackboneElement	A substance used to create the material(s) of which the device is made
[props.modelNumber]	string	The model number for the device
[props.note]	Annotation	Device notes and comments
[props.onlineInformation]	string	Access to on-line information
[props.owner]	Reference	Organization responsible for device
[props.parentDevice]	Reference	The parent device it can be part of
[props.physicalCharacteristics]	ProdCharacteristic	Dimensions, color etc.
[props.property]	BackboneElement	The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
[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.safety]	string	Safety characteristics of the device. Accepts all values from http://hl7.org/fhir/ValueSet/device-safety
[props.shelfLifeStorage]	ProductShelfLife	Shelf Life and storage information
[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.type]	string	What kind of device or device system this is. Accepts all values from http://hl7.org/fhir/ValueSet/device-kind
[props.udiDeviceIdentifier]	BackboneElement	Unique Device Identifier (UDI) Barcode string
[props.url]	string	Network address to contact device
[props.version]	string	Available versions

---

builders.deviceMetric

deviceMetric(props)

Create a DeviceMetric resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.calibration]	BackboneElement	Describes the calibrations that have been performed or that are required to be performed
[props.category]	string	measurement
[props.color]	string	black
[props.identifier]	Identifier	Instance identifier
[props.measurementPeriod]	Timing	Describes the measurement repetition time
[props.operationalStatus]	string	on
[props.parent]	Reference	Describes the link to the parent Device
[props.source]	Reference	Describes the link to the source Device
[props.type]	string	Identity of metric, for example Heart Rate or PEEP Setting. Accepts all values from http://hl7.org/fhir/ValueSet/devicemetric-type
[props.unit]	string	Unit of Measure for the Metric. Accepts all values from http://hl7.org/fhir/ValueSet/devicemetric-type

---

builders.deviceRequest

deviceRequest(props)

Create a DeviceRequest resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.authoredOn]	dateTime	When recorded
[props.basedOn]	Reference	What request fulfills
[props.code]	string	Device requested. Accepts all values from http://hl7.org/fhir/ValueSet/device-kind
[props.encounter]	Reference	Encounter motivating request
[props.groupIdentifier]	Identifier	Identifier of composite request
[props.identifier]	Identifier	External Request identifier
[props.instantiatesCanonical]	canonical	Instantiates FHIR protocol or definition
[props.instantiatesUri]	string	Instantiates external protocol or definition
[props.insurance]	Reference	Associated insurance coverage
[props.intent]	string	proposal
[props.note]	Annotation	Notes or comments
[props.occurrence]	dateTime | Period | Timing	Desired time or schedule for use
[props.parameter]	BackboneElement	Device details
[props.performer]	Reference	Requested Filler
[props.performerType]	string	Filler role. Accepts all values from http://hl7.org/fhir/ValueSet/participant-role
[props.priorRequest]	Reference	What request replaces
[props.priority]	string	routine
[props.reasonCode]	string	Coded Reason for request. Accepts all values from http://hl7.org/fhir/ValueSet/condition-code
[props.reasonReference]	Reference	Linked Reason for request
[props.relevantHistory]	Reference	Request provenance
[props.requester]	Reference	Who/what is requesting diagnostics
[props.status]	string	draft
[props.subject]	Reference	Focus of request
[props.supportingInfo]	Reference	Additional clinical information

---

builders.deviceUseStatement

deviceUseStatement(props)

Create a DeviceUseStatement resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.basedOn]	Reference	Fulfills plan, proposal or order
[props.bodySite]	string	Target body site. Accepts all values from http://hl7.org/fhir/ValueSet/body-site
[props.derivedFrom]	Reference	Supporting information
[props.device]	Reference	Reference to device used
[props.identifier]	Identifier	External identifier for this record
[props.note]	Annotation	Addition details (comments, instructions)
[props.reasonCode]	CodeableConcept	Why device was used
[props.reasonReference]	Reference	Why was DeviceUseStatement performed?
[props.recordedOn]	dateTime	When statement was recorded
[props.source]	Reference	Who made the statement
[props.status]	string	active
[props.subject]	Reference	Patient using device
[props.timing]	Timing | Period | dateTime	How often the device was used

---

builders.diagnosticReport

diagnosticReport(props)

Create a DiagnosticReport resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.basedOn]	Reference	What was requested
[props.category]	string	Service category. Accepts all values from http://hl7.org/fhir/ValueSet/diagnostic-service-sections
[props.code]	string	Name/Code for this diagnostic report. Accepts all values from http://hl7.org/fhir/ValueSet/report-codes
[props.conclusion]	string	Clinical conclusion (interpretation) of test results
[props.conclusionCode]	string	Codes for the clinical conclusion of test results. Accepts all values from http://hl7.org/fhir/ValueSet/clinical-findings
[props.effective]	dateTime | Period	Clinically relevant time/time-period for report
[props.encounter]	Reference	Health care event when test ordered
[props.identifier]	Identifier	Business identifier for report
[props.imagingStudy]	Reference	Reference to full details of imaging associated with the diagnostic report
[props.issued]	instant	DateTime this version was made
[props.media]	BackboneElement	Key images associated with this report
[props.performer]	Reference	Responsible Diagnostic Service
[props.presentedForm]	Attachment	Entire report as issued
[props.result]	Reference	Observations
[props.resultsInterpreter]	Reference	Primary result interpreter
[props.specimen]	Reference	Specimens this report is based on
[props.status]	string	registered
[props.subject]	Reference	The subject of the report - usually, but not always, the patient

---

builders.domainResource

domainResource(props)

Create a DomainResource resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).

---

builders.encounter

encounter(props)

Create a Encounter resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.account]	Reference	The set of accounts that may be used for billing for this Encounter
[props.appointment]	Reference	The appointment that scheduled this encounter
[props.basedOn]	Reference	The ServiceRequest that initiated this encounter
[props.class]	string	Classification of patient encounter. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
[props.classHistory]	BackboneElement	List of past encounter classes
[props.diagnosis]	BackboneElement	The list of diagnosis relevant to this encounter
[props.episodeOfCare]	Reference	Episode(s) of care that this encounter should be recorded against
[props.hospitalization]	BackboneElement	Details about the admission to a healthcare service
[props.identifier]	Identifier	Identifier(s) by which this encounter is known
[props.length]	Duration	Quantity of time the encounter lasted (less time absent)
[props.location]	BackboneElement	List of locations where the patient has been
[props.partOf]	Reference	Another Encounter this encounter is part of
[props.participant]	BackboneElement	List of participants involved in the encounter
[props.period]	Period	The start and end time of the encounter
[props.priority]	string	Indicates the urgency of the encounter. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ActPriority
[props.reasonCode]	string	Coded reason the encounter takes place. Accepts all values from http://hl7.org/fhir/ValueSet/encounter-reason
[props.reasonReference]	Reference	Reason the encounter takes place (reference)
[props.serviceProvider]	Reference	The organization (facility) responsible for this encounter
[props.serviceType]	string	Specific type of service. Accepts all values from http://hl7.org/fhir/ValueSet/service-type
[props.status]	string	planned
[props.statusHistory]	BackboneElement	List of past encounter statuses
[props.subject]	Reference	The patient or group present at the encounter
[props.type]	string	Specific type of encounter. Accepts all values from http://hl7.org/fhir/ValueSet/encounter-type

---

builders.enrollmentRequest

enrollmentRequest(props)

Create a EnrollmentRequest resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.candidate]	Reference	The subject to be enrolled
[props.coverage]	Reference	Insurance information
[props.created]	dateTime	Creation date
[props.identifier]	Identifier	Business Identifier
[props.insurer]	Reference	Target
[props.provider]	Reference	Responsible practitioner
[props.status]	string	active

---

builders.enrollmentResponse

enrollmentResponse(props)

Create a EnrollmentResponse resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.created]	dateTime	Creation date
[props.disposition]	string	Disposition Message
[props.identifier]	Identifier	Business Identifier
[props.organization]	Reference	Insurer
[props.outcome]	string	queued
[props.request]	Reference	Claim reference
[props.requestProvider]	Reference	Responsible practitioner
[props.status]	string	active

---

builders.episodeOfCare

episodeOfCare(props)

Create a EpisodeOfCare resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.account]	Reference	The set of accounts that may be used for billing for this EpisodeOfCare
[props.careManager]	Reference	Care manager/care coordinator for the patient
[props.diagnosis]	BackboneElement	The list of diagnosis relevant to this episode of care
[props.identifier]	Identifier	Business Identifier(s) relevant for this EpisodeOfCare
[props.managingOrganization]	Reference	Organization that assumes care
[props.patient]	Reference	The patient who is the focus of this episode of care
[props.period]	Period	Interval during responsibility is assumed
[props.referralRequest]	Reference	Originating Referral Request(s)
[props.status]	string	planned
[props.statusHistory]	BackboneElement	Past list of status codes (the current status may be included to cover the start date of the status)
[props.team]	Reference	Other practitioners facilitating this episode of care
[props.type]	string	Type/class - e.g. specialist referral, disease management. Accepts all values from http://hl7.org/fhir/ValueSet/episodeofcare-type

---

builders.eventDefinition

eventDefinition(props)

Create a EventDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.approvalDate]	date	When the event definition was approved by publisher
[props.author]	ContactDetail	Who authored the content
[props.contact]	ContactDetail	Contact details for the publisher
[props.copyright]	markdown	Use and/or publishing restrictions
[props.date]	dateTime	Date last changed
[props.description]	markdown	Natural language description of the event definition
[props.editor]	ContactDetail	Who edited the content
[props.effectivePeriod]	Period	When the event definition is expected to be used
[props.endorser]	ContactDetail	Who endorsed the content
[props.experimental]	boolean	For testing purposes, not real usage
[props.identifier]	Identifier	Additional identifier for the event definition
[props.jurisdiction]	string	Intended jurisdiction for event definition (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.lastReviewDate]	date	When the event definition was last reviewed
[props.name]	string	Name for this event definition (computer friendly)
[props.publisher]	string	Name of the publisher (organization or individual)
[props.purpose]	markdown	Why this event definition is defined
[props.relatedArtifact]	RelatedArtifact	Additional documentation, citations, etc.
[props.reviewer]	ContactDetail	Who reviewed the content
[props.status]	string	draft
[props.subject]	string	Type of individual the event definition is focused on. Accepts all values from http://hl7.org/fhir/ValueSet/subject-type
[props.subtitle]	string	Subordinate title of the event definition
[props.title]	string	Name for this event definition (human friendly)
[props.topic]	string	E.g. Education, Treatment, Assessment, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/definition-topic
[props.trigger]	TriggerDefinition	"when" the event occurs (multiple = 'or')
[props.url]	string	Canonical identifier for this event definition, represented as a URI (globally unique)
[props.usage]	string	Describes the clinical usage of the event definition
[props.useContext]	UsageContext	The context that the content is intended to support
[props.version]	string	Business version of the event definition

---

builders.evidence

evidence(props)

Create a Evidence resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.approvalDate]	date	When the summary was approved by publisher
[props.assertion]	markdown	Declarative description of the Evidence
[props.author]	ContactDetail	Who authored the content
[props.certainty]	BackboneElement	Certainty or quality of the evidence
[props.citeAs]	Reference | markdown	Citation for this evidence
[props.contact]	ContactDetail	Contact details for the publisher
[props.date]	dateTime	Date last changed
[props.description]	markdown	Description of the particular summary
[props.editor]	ContactDetail	Who edited the content
[props.endorser]	ContactDetail	Who endorsed the content
[props.identifier]	Identifier	Additional identifier for the summary
[props.lastReviewDate]	date	When the summary was last reviewed
[props.note]	Annotation	Footnotes and/or explanatory notes
[props.publisher]	string	Name of the publisher (organization or individual)
[props.relatedArtifact]	RelatedArtifact	Link or citation to artifact associated with the summary
[props.reviewer]	ContactDetail	Who reviewed the content
[props.statistic]	BackboneElement	Values and parameters for a single statistic
[props.status]	string	draft
[props.studyType]	string	The type of study that produced this evidence. Accepts all values from http://hl7.org/fhir/ValueSet/study-type
[props.synthesisType]	string	The method to combine studies. Accepts all values from http://hl7.org/fhir/ValueSet/synthesis-type
[props.title]	string	Name for this summary (human friendly)
[props.url]	string	Canonical identifier for this evidence, represented as a globally unique URI
[props.useContext]	UsageContext	The context that the content is intended to support
[props.variableDefinition]	BackboneElement	Evidence variable such as population, exposure, or outcome
[props.version]	string	Business version of this summary

---

builders.evidenceReport

evidenceReport(props)

Create a EvidenceReport resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.author]	ContactDetail	Who authored the content
[props.citeAs]	Reference | markdown	Citation for this report
[props.contact]	ContactDetail	Contact details for the publisher
[props.editor]	ContactDetail	Who edited the content
[props.endorser]	ContactDetail	Who endorsed the content
[props.identifier]	Identifier	Unique identifier for the evidence report
[props.note]	Annotation	Used for footnotes and annotations
[props.publisher]	string	Name of the publisher (organization or individual)
[props.relatedArtifact]	RelatedArtifact	Link, description or reference to artifact associated with the report
[props.relatedIdentifier]	Identifier	Identifiers for articles that may relate to more than one evidence report
[props.relatesTo]	BackboneElement	Relationships to other compositions/documents
[props.reviewer]	ContactDetail	Who reviewed the content
[props.section]	BackboneElement	Composition is broken into sections
[props.status]	string	draft
[props.subject]	BackboneElement	Focus of the report
[props.type]	string	Kind of report. Accepts all values from http://hl7.org/fhir/ValueSet/evidence-report-type
[props.url]	string	Canonical identifier for this EvidenceReport, represented as a globally unique URI
[props.useContext]	UsageContext	The context that the content is intended to support

---

builders.evidenceVariable

evidenceVariable(props)

Create a EvidenceVariable resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.actual]	boolean	Actual or conceptual
[props.author]	ContactDetail	Who authored the content
[props.category]	BackboneElement	A grouping for ordinal or polychotomous variables
[props.characteristic]	BackboneElement	What defines the members of the evidence element
[props.characteristicCombination]	string	intersection
[props.contact]	ContactDetail	Contact details for the publisher
[props.date]	dateTime	Date last changed
[props.description]	markdown	Natural language description of the evidence variable
[props.editor]	ContactDetail	Who edited the content
[props.endorser]	ContactDetail	Who endorsed the content
[props.handling]	string	continuous
[props.identifier]	Identifier	Additional identifier for the evidence variable
[props.name]	string	Name for this evidence variable (computer friendly)
[props.note]	Annotation	Used for footnotes or explanatory notes
[props.publisher]	string	Name of the publisher (organization or individual)
[props.relatedArtifact]	RelatedArtifact	Additional documentation, citations, etc.
[props.reviewer]	ContactDetail	Who reviewed the content
[props.shortTitle]	string	Title for use in informal contexts
[props.status]	string	draft
[props.subtitle]	string	Subordinate title of the EvidenceVariable
[props.title]	string	Name for this evidence variable (human friendly)
[props.url]	string	Canonical identifier for this evidence variable, represented as a URI (globally unique)
[props.useContext]	UsageContext	The context that the content is intended to support
[props.version]	string	Business version of the evidence variable

---

builders.explanationOfBenefit

explanationOfBenefit(props)

Create a ExplanationOfBenefit resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.accident]	BackboneElement	Details of the event
[props.addItem]	BackboneElement	Insurer added line items
[props.adjudication]	any	Header-level adjudication
[props.benefitBalance]	BackboneElement	Balance by Benefit Category
[props.benefitPeriod]	Period	When the benefits are applicable
[props.billablePeriod]	Period	Relevant time frame for the claim
[props.careTeam]	BackboneElement	Care Team members
[props.claim]	Reference	Claim reference
[props.claimResponse]	Reference	Claim response reference
[props.created]	dateTime	Response creation date
[props.diagnosis]	BackboneElement	Pertinent diagnosis information
[props.disposition]	string	Disposition Message
[props.enterer]	Reference	Author of the claim
[props.facility]	Reference	Servicing Facility
[props.form]	Attachment	Printed reference or actual form
[props.formCode]	string	Printed form identifier. Accepts all values from http://hl7.org/fhir/ValueSet/forms
[props.fundsReserve]	string	Funds reserved status. Accepts all values from http://hl7.org/fhir/ValueSet/fundsreserve
[props.fundsReserveRequested]	string	For whom to reserve funds. Accepts all values from http://hl7.org/fhir/ValueSet/fundsreserve
[props.identifier]	Identifier	Business Identifier for the resource
[props.insurance]	BackboneElement	Patient insurance information
[props.insurer]	Reference	Party responsible for reimbursement
[props.item]	BackboneElement	Product or service provided
[props.originalPrescription]	Reference	Original prescription if superceded by fulfiller
[props.outcome]	string	queued
[props.patient]	Reference	The recipient of the products and services
[props.payee]	BackboneElement	Recipient of benefits payable
[props.payment]	BackboneElement	Payment Details
[props.preAuthRef]	string	Preauthorization reference
[props.preAuthRefPeriod]	Period	Preauthorization in-effect period
[props.precedence]	number	Precedence (primary, secondary, etc.)
[props.prescription]	Reference	Prescription authorizing services or products
[props.priority]	string	Desired processing urgency. Accepts all values from http://hl7.org/fhir/ValueSet/process-priority
[props.procedure]	BackboneElement	Clinical procedures performed
[props.processNote]	BackboneElement	Note concerning adjudication
[props.provider]	Reference	Party responsible for the claim
[props.referral]	Reference	Treatment Referral
[props.related]	BackboneElement	Prior or corollary claims
[props.status]	string	active
[props.subType]	string	More granular claim type. Accepts all values from http://hl7.org/fhir/ValueSet/claim-subtype
[props.supportingInfo]	BackboneElement	Supporting information
[props.total]	BackboneElement	Adjudication totals
[props.type]	string	Category or discipline. Accepts all values from http://hl7.org/fhir/ValueSet/claim-type
[props.use]	string	claim

---

builders.familyMemberHistory

familyMemberHistory(props)

Create a FamilyMemberHistory resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.age]	Age | Range | string	(approximate) age
[props.born]	Period | date | string	(approximate) date of birth
[props.condition]	BackboneElement	Condition that the related person had
[props.dataAbsentReason]	string	subject-unknown
[props.date]	dateTime	When history was recorded or last updated
[props.deceased]	boolean | Age | Range | date | string	Dead? How old/when?
[props.estimatedAge]	boolean	Age is estimated?
[props.identifier]	Identifier	External Id(s) for this record
[props.instantiatesCanonical]	canonical	Instantiates FHIR protocol or definition
[props.instantiatesUri]	string	Instantiates external protocol or definition
[props.name]	string	The family member described
[props.note]	Annotation	General note about related person
[props.patient]	Reference	Patient history is about
[props.reasonCode]	string	Why was family member history performed?. Accepts all values from http://hl7.org/fhir/ValueSet/clinical-findings
[props.reasonReference]	Reference	Why was family member history performed?
[props.relationship]	string	Relationship to the subject. Accepts all values from http://terminology.hl7.org/ValueSet/v3-FamilyMember
[props.sex]	string	male
[props.status]	string	partial

---

builders.flag

flag(props)

Create a Flag resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.author]	Reference	Flag creator
[props.category]	string	Clinical, administrative, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/flag-category
[props.code]	string	Coded or textual message to display to user. Accepts all values from http://hl7.org/fhir/ValueSet/flag-code
[props.encounter]	Reference	Alert relevant during encounter
[props.identifier]	Identifier	Business identifier
[props.period]	Period	Time period when flag is active
[props.status]	string	active
[props.subject]	Reference	Who/What is flag about?

---

builders.goal

goal(props)

Create a Goal resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.achievementStatus]	string	in-progress
[props.addresses]	Reference	Issues addressed by this goal
[props.category]	string	E.g. Treatment, dietary, behavioral, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/goal-category
[props.description]	string	Code or text describing goal. Accepts all values from http://hl7.org/fhir/ValueSet/clinical-findings
[props.expressedBy]	Reference	Who's responsible for creating Goal?
[props.identifier]	Identifier	External Ids for this goal
[props.lifecycleStatus]	string	proposed
[props.note]	Annotation	Comments about the goal
[props.outcomeCode]	string	What result was achieved regarding the goal?. Accepts all values from http://hl7.org/fhir/ValueSet/clinical-findings
[props.outcomeReference]	Reference	Observation that resulted from goal
[props.priority]	string	high-priority
[props.start]	string	When goal pursuit begins. Accepts all values from http://hl7.org/fhir/ValueSet/goal-start-event
[props.statusDate]	date	When goal status took effect
[props.statusReason]	string	Reason for current status
[props.subject]	Reference	Who this goal is intended for
[props.target]	BackboneElement	Target outcome for the goal

---

builders.group

group(props)

Create a Group resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.active]	boolean	Whether this group's record is in active use
[props.actual]	boolean	Descriptive or actual
[props.characteristic]	BackboneElement	Include / Exclude group members by Trait
[props.code]	CodeableConcept	Kind of Group members
[props.identifier]	Identifier	Unique id
[props.managingEntity]	Reference	Entity that is the custodian of the Group's definition
[props.member]	BackboneElement	Who or what is in group
[props.name]	string	Label for Group
[props.quantity]	unsignedInt	Number of members
[props.type]	string	person

---

builders.guidanceResponse

guidanceResponse(props)

Create a GuidanceResponse resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.dataRequirement]	DataRequirement	Additional required data
[props.encounter]	Reference	Encounter during which the response was returned
[props.evaluationMessage]	Reference	Messages resulting from the evaluation of the artifact or artifacts
[props.identifier]	Identifier	Business identifier
[props.module]	string | canonical | CodeableConcept	What guidance was requested
[props.note]	Annotation	Additional notes about the response
[props.occurrenceDateTime]	dateTime	When the guidance response was processed
[props.outputParameters]	Reference	The output parameters of the evaluation, if any
[props.performer]	Reference	Device returning the guidance
[props.reasonCode]	CodeableConcept	Why guidance is needed
[props.reasonReference]	Reference	Why guidance is needed
[props.requestIdentifier]	Identifier	The identifier of the request associated with this response, if any
[props.result]	Reference	Proposed actions, if any
[props.status]	string	success
[props.subject]	Reference	Patient the request was performed for

---

builders.healthcareService

healthcareService(props)

Create a HealthcareService resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.active]	boolean	Whether this HealthcareService record is in active use
[props.appointmentRequired]	boolean	If an appointment is required for access to this service
[props.availabilityExceptions]	string	Description of availability exceptions
[props.availableTime]	BackboneElement	Times the Service Site is available
[props.category]	string	Broad category of service being performed or delivered. Accepts all values from http://hl7.org/fhir/ValueSet/service-category
[props.characteristic]	CodeableConcept	Collection of characteristics (attributes)
[props.comment]	string	Additional description and/or any specific issues not covered elsewhere
[props.communication]	string	The language that this service is offered in. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.coverageArea]	Reference	Location(s) service is intended for/available to
[props.eligibility]	BackboneElement	Specific eligibility requirements required to use the service
[props.endpoint]	Reference	Technical endpoints providing access to electronic services operated for the healthcare service
[props.extraDetails]	markdown	Extra details about the service that can't be placed in the other fields
[props.identifier]	Identifier	External identifiers for this item
[props.location]	Reference	Location(s) where service may be provided
[props.name]	string	Description of service as presented to a consumer while searching
[props.notAvailable]	BackboneElement	Not available during this time due to provided reason
[props.photo]	Attachment	Facilitates quick identification of the service
[props.program]	string	Programs that this service is applicable to. Accepts all values from http://hl7.org/fhir/ValueSet/program
[props.providedBy]	Reference	Organization that provides this service
[props.referralMethod]	string	Ways that the service accepts referrals. Accepts all values from http://hl7.org/fhir/ValueSet/service-referral-method
[props.serviceProvisionCode]	string	Conditions under which service is available/offered. Accepts all values from http://hl7.org/fhir/ValueSet/service-provision-conditions
[props.specialty]	string	Specialties handled by the HealthcareService. Accepts all values from http://hl7.org/fhir/ValueSet/c80-practice-codes
[props.telecom]	ContactPoint	Contacts related to the healthcare service
[props.type]	string	Type of service that may be delivered or performed. Accepts all values from http://hl7.org/fhir/ValueSet/service-type

---

builders.imagingStudy

imagingStudy(props)

Create a ImagingStudy resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.basedOn]	Reference	Request fulfilled
[props.description]	string	Institution-generated description
[props.encounter]	Reference	Encounter with which this imaging study is associated
[props.endpoint]	Reference	Study access endpoint
[props.identifier]	Identifier	Identifiers for the whole study
[props.interpreter]	Reference	Who interpreted images
[props.location]	Reference	Where ImagingStudy occurred
[props.modality]	string	All series modality if actual acquisition modalities. Accepts all values from http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html
[props.note]	Annotation	User-defined comments
[props.numberOfInstances]	unsignedInt	Number of Study Related Instances
[props.numberOfSeries]	unsignedInt	Number of Study Related Series
[props.procedureCode]	string	The performed procedure code. Accepts all values from http://www.rsna.org/RadLex_Playbook.aspx
[props.procedureReference]	Reference	The performed Procedure reference
[props.reasonCode]	string	Why the study was requested. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-reason
[props.reasonReference]	Reference	Why was study performed
[props.referrer]	Reference	Referring physician
[props.series]	BackboneElement	Each study has one or more series of instances
[props.started]	dateTime	When the study was started
[props.status]	string	registered
[props.subject]	Reference	Who or what is the subject of the study

---

builders.immunization

immunization(props)

Create a Immunization resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.doseQuantity]	Quantity	Amount of vaccine administered
[props.education]	BackboneElement	Educational material presented to patient
[props.encounter]	Reference	Encounter immunization was part of
[props.expirationDate]	date	Vaccine expiration date
[props.fundingSource]	string	Funding source for the vaccine. Accepts all values from http://hl7.org/fhir/ValueSet/immunization-funding-source
[props.identifier]	Identifier	Business identifier
[props.isSubpotent]	boolean	Dose potency
[props.location]	Reference	Where immunization occurred
[props.lotNumber]	string	Vaccine lot number
[props.manufacturer]	Reference	Vaccine manufacturer
[props.note]	Annotation	Additional immunization notes
[props.occurrence]	dateTime | string	Vaccine administration date
[props.patient]	Reference	Who was immunized
[props.performer]	BackboneElement	Who performed event
[props.primarySource]	boolean	Indicates context the data was recorded in
[props.programEligibility]	string	Patient eligibility for a vaccination program. Accepts all values from http://hl7.org/fhir/ValueSet/immunization-program-eligibility
[props.protocolApplied]	BackboneElement	Protocol followed by the provider
[props.reaction]	BackboneElement	Details of a reaction that follows immunization
[props.reasonCode]	string	Why immunization occurred. Accepts all values from http://hl7.org/fhir/ValueSet/immunization-reason
[props.reasonReference]	Reference	Why immunization occurred
[props.recorded]	dateTime	When the immunization was first captured in the subject's record
[props.reportOrigin]	string	Indicates the source of a secondarily reported record. Accepts all values from http://hl7.org/fhir/ValueSet/immunization-origin
[props.route]	string	How vaccine entered body. Accepts all values from http://hl7.org/fhir/ValueSet/immunization-route
[props.site]	string	Body site vaccine was administered. Accepts all values from http://hl7.org/fhir/ValueSet/immunization-site
[props.status]	string	completed
[props.statusReason]	string	Reason not done. Accepts all values from http://hl7.org/fhir/ValueSet/immunization-status-reason
[props.subpotentReason]	string	Reason for being subpotent. Accepts all values from http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
[props.vaccineCode]	string	Vaccine product administered. Accepts all values from http://hl7.org/fhir/ValueSet/vaccine-code

---

builders.immunizationEvaluation

immunizationEvaluation(props)

Create a ImmunizationEvaluation resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.authority]	Reference	Who is responsible for publishing the recommendations
[props.date]	dateTime	Date evaluation was performed
[props.description]	string	Evaluation notes
[props.doseNumber]	number | string	Dose number within series
[props.doseStatus]	string	Status of the dose relative to published recommendations. Accepts all values from http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status
[props.doseStatusReason]	string	Reason for the dose status. Accepts all values from http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status-reason
[props.identifier]	Identifier	Business identifier
[props.immunizationEvent]	Reference	Immunization being evaluated
[props.patient]	Reference	Who this evaluation is for
[props.series]	string	Name of vaccine series
[props.seriesDoses]	number | string	Recommended number of doses for immunity
[props.status]	string	completed
[props.targetDisease]	string	Evaluation target disease. Accepts all values from http://hl7.org/fhir/ValueSet/immunization-evaluation-target-disease

---

builders.immunizationRecommendation

immunizationRecommendation(props)

Create a ImmunizationRecommendation resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.authority]	Reference	Who is responsible for protocol
[props.date]	dateTime	Date recommendation(s) created
[props.identifier]	Identifier	Business identifier
[props.patient]	Reference	Who this profile is for
[props.recommendation]	BackboneElement	Vaccine administration recommendations

---

builders.ingredient

ingredient(props)

Create a Ingredient resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.allergenicIndicator]	boolean	If the ingredient is a known or suspected allergen
[props.for]	Reference	The product which this ingredient is a constituent part of
[props.function]	string	Precise action within the drug product, e.g. antioxidant, alkalizing agent. Accepts all values from http://hl7.org/fhir/ValueSet/ingredient-function
[props.identifier]	Identifier	An identifier or code by which the ingredient can be referenced
[props.manufacturer]	BackboneElement	An organization that manufactures this ingredient
[props.role]	string	Purpose of the ingredient within the product, e.g. active, inactive. Accepts all values from http://hl7.org/fhir/ValueSet/ingredient-role
[props.status]	string	draft
[props.substance]	BackboneElement	The substance that comprises this ingredient

---

builders.insurancePlan

insurancePlan(props)

Create a InsurancePlan resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.administeredBy]	Reference	Product administrator
[props.alias]	string	Alternate names
[props.contact]	BackboneElement	Contact for the product
[props.coverage]	BackboneElement	Coverage details
[props.coverageArea]	Reference	Where product applies
[props.endpoint]	Reference	Technical endpoint
[props.identifier]	Identifier	Business Identifier for Product
[props.name]	string	Official name
[props.network]	Reference	What networks are Included
[props.ownedBy]	Reference	Plan issuer
[props.period]	Period	When the product is available
[props.plan]	BackboneElement	Plan details
[props.status]	string	draft
[props.type]	string	Kind of product. Accepts all values from http://hl7.org/fhir/ValueSet/insuranceplan-type

---

builders.invoice

invoice(props)

Create a Invoice resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.account]	Reference	Account that is being balanced
[props.cancelledReason]	string	Reason for cancellation of this Invoice
[props.date]	dateTime	Invoice date / posting date
[props.identifier]	Identifier	Business Identifier for item
[props.issuer]	Reference	Issuing Organization of Invoice
[props.lineItem]	BackboneElement	Line items of this Invoice
[props.note]	Annotation	Comments made about the invoice
[props.participant]	BackboneElement	Participant in creation of this Invoice
[props.paymentTerms]	markdown	Payment details
[props.recipient]	Reference	Recipient of this invoice
[props.status]	string	draft
[props.subject]	Reference	Recipient(s) of goods and services
[props.totalGross]	Money	Gross total of this Invoice
[props.totalNet]	Money	Net total of this Invoice
[props.totalPriceComponent]	any	Components of Invoice total
[props.type]	CodeableConcept	Type of Invoice

---

builders.library

library(props)

Create a Library resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.approvalDate]	date	When the library was approved by publisher
[props.author]	ContactDetail	Who authored the content
[props.contact]	ContactDetail	Contact details for the publisher
[props.content]	Attachment	Contents of the library, either embedded or referenced
[props.copyright]	markdown	Use and/or publishing restrictions
[props.dataRequirement]	DataRequirement	What data is referenced by this library
[props.date]	dateTime	Date last changed
[props.description]	markdown	Natural language description of the library
[props.editor]	ContactDetail	Who edited the content
[props.effectivePeriod]	Period	When the library is expected to be used
[props.endorser]	ContactDetail	Who endorsed the content
[props.experimental]	boolean	For testing purposes, not real usage
[props.identifier]	Identifier	Additional identifier for the library
[props.jurisdiction]	string	Intended jurisdiction for library (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.lastReviewDate]	date	When the library was last reviewed
[props.name]	string	Name for this library (computer friendly)
[props.parameter]	ParameterDefinition	Parameters defined by the library
[props.publisher]	string	Name of the publisher (organization or individual)
[props.purpose]	markdown	Why this library is defined
[props.relatedArtifact]	RelatedArtifact	Additional documentation, citations, etc.
[props.reviewer]	ContactDetail	Who reviewed the content
[props.status]	string	draft
[props.subject]	string	Type of individual the library content is focused on. Accepts all values from http://hl7.org/fhir/ValueSet/subject-type
[props.subtitle]	string	Subordinate title of the library
[props.title]	string	Name for this library (human friendly)
[props.topic]	string	E.g. Education, Treatment, Assessment, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/definition-topic
[props.type]	string	logic-library
[props.url]	string	Canonical identifier for this library, represented as a URI (globally unique)
[props.usage]	string	Describes the clinical usage of the library
[props.useContext]	UsageContext	The context that the content is intended to support
[props.version]	string	Business version of the library

---

builders.list

list(props)

Create a List resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.code]	string	What the purpose of this list is. Accepts all values from http://hl7.org/fhir/ValueSet/list-example-codes
[props.date]	dateTime	When the list was prepared
[props.emptyReason]	string	Why list is empty. Accepts all values from http://hl7.org/fhir/ValueSet/list-empty-reason
[props.encounter]	Reference	Context in which list created
[props.entry]	BackboneElement	Entries in the list
[props.identifier]	Identifier	Business identifier
[props.mode]	string	working
[props.note]	Annotation	Comments about the list
[props.orderedBy]	string	What order the list has. Accepts all values from http://hl7.org/fhir/ValueSet/list-order
[props.source]	Reference	Who and/or what defined the list contents (aka Author)
[props.status]	string	current
[props.subject]	Reference	If all resources have the same subject
[props.title]	string	Descriptive name for the list

---

builders.location

location(props)

Create a Location resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.address]	Address	Physical location
[props.alias]	string	A list of alternate names that the location is known as, or was known as, in the past
[props.availabilityExceptions]	string	Description of availability exceptions
[props.description]	string	Additional details about the location that could be displayed as further information to identify the location beyond its name
[props.endpoint]	Reference	Technical endpoints providing access to services operated for the location
[props.hoursOfOperation]	BackboneElement	What days/times during a week is this location usually open
[props.identifier]	Identifier	Unique code or number identifying the location to its users
[props.managingOrganization]	Reference	Organization responsible for provisioning and upkeep
[props.mode]	string	instance
[props.name]	string	Name of the location as used by humans
[props.operationalStatus]	string	The operational status of the location (typically only for a bed/room). Accepts all values from http://terminology.hl7.org/ValueSet/v2-0116
[props.partOf]	Reference	Another Location this one is physically a part of
[props.physicalType]	string	Physical form of the location. Accepts all values from http://hl7.org/fhir/ValueSet/location-physical-type
[props.position]	BackboneElement	The absolute geographic location
[props.status]	string	active
[props.telecom]	ContactPoint	Contact details of the location
[props.type]	string	Type of function performed. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType

---

builders.manufacturedItemDefinition

manufacturedItemDefinition(props)

Create a ManufacturedItemDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.identifier]	Identifier	Unique identifier
[props.ingredient]	string	The ingredients of this manufactured item. Only needed if these are not specified by incoming references from the Ingredient resource. Accepts all values from http://hl7.org/fhir/ValueSet/substance-codes
[props.manufacturedDoseForm]	string	Dose form as manufactured (before any necessary transformation). Accepts all values from http://hl7.org/fhir/ValueSet/manufactured-dose-form
[props.manufacturer]	Reference	Manufacturer of the item (Note that this should be named "manufacturer" but it currently causes technical issues)
[props.property]	BackboneElement	General characteristics of this item
[props.status]	string	draft
[props.unitOfPresentation]	string	The “real world” units in which the quantity of the item is described. Accepts all values from http://hl7.org/fhir/ValueSet/unit-of-presentation

---

builders.measure

measure(props)

Create a Measure resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.approvalDate]	date	When the measure was approved by publisher
[props.author]	ContactDetail	Who authored the content
[props.clinicalRecommendationStatement]	markdown	Summary of clinical guidelines
[props.compositeScoring]	string	opportunity
[props.contact]	ContactDetail	Contact details for the publisher
[props.copyright]	markdown	Use and/or publishing restrictions
[props.date]	dateTime	Date last changed
[props.definition]	markdown	Defined terms used in the measure documentation
[props.description]	markdown	Natural language description of the measure
[props.disclaimer]	markdown	Disclaimer for use of the measure or its referenced content
[props.editor]	ContactDetail	Who edited the content
[props.effectivePeriod]	Period	When the measure is expected to be used
[props.endorser]	ContactDetail	Who endorsed the content
[props.experimental]	boolean	For testing purposes, not real usage
[props.group]	BackboneElement	Population criteria group
[props.guidance]	markdown	Additional guidance for implementers
[props.identifier]	Identifier	Additional identifier for the measure
[props.improvementNotation]	string	increase
[props.jurisdiction]	string	Intended jurisdiction for measure (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.lastReviewDate]	date	When the measure was last reviewed
[props.library]	canonical	Logic used by the measure
[props.name]	string	Name for this measure (computer friendly)
[props.publisher]	string	Name of the publisher (organization or individual)
[props.purpose]	markdown	Why this measure is defined
[props.rateAggregation]	string	How is rate aggregation performed for this measure
[props.rationale]	markdown	Detailed description of why the measure exists
[props.relatedArtifact]	RelatedArtifact	Additional documentation, citations, etc.
[props.reviewer]	ContactDetail	Who reviewed the content
[props.riskAdjustment]	string	How risk adjustment is applied for this measure
[props.scoring]	string	proportion
[props.status]	string	draft
[props.subject]	string	E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. Accepts all values from http://hl7.org/fhir/ValueSet/subject-type
[props.subtitle]	string	Subordinate title of the measure
[props.supplementalData]	BackboneElement	What other data should be reported with the measure
[props.title]	string	Name for this measure (human friendly)
[props.topic]	string	The category of the measure, such as Education, Treatment, Assessment, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/definition-topic
[props.type]	string	process
[props.url]	string	Canonical identifier for this measure, represented as a URI (globally unique)
[props.usage]	string	Describes the clinical usage of the measure
[props.useContext]	UsageContext	The context that the content is intended to support
[props.version]	string	Business version of the measure

---

builders.measureReport

measureReport(props)

Create a MeasureReport resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.date]	dateTime	When the report was generated
[props.evaluatedResource]	Reference	What data was used to calculate the measure score
[props.group]	BackboneElement	Measure results for each group
[props.identifier]	Identifier	Additional identifier for the MeasureReport
[props.improvementNotation]	string	increase
[props.measure]	canonical	What measure was calculated
[props.period]	Period	What period the report covers
[props.reporter]	Reference	Who is reporting the data
[props.status]	string	complete
[props.subject]	Reference	What individual(s) the report is for
[props.type]	string	individual

---

builders.media

media(props)

Create a Media resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.basedOn]	Reference	Procedure that caused this media to be created
[props.bodySite]	string	Observed body part. Accepts all values from http://hl7.org/fhir/ValueSet/body-site
[props.content]	Attachment	Actual Media - reference or data
[props.created]	dateTime | Period	When Media was collected
[props.device]	Reference	Observing Device
[props.deviceName]	string	Name of the device/manufacturer
[props.duration]	decimal	Length in seconds (audio / video)
[props.encounter]	Reference	Encounter associated with media
[props.frames]	number	Number of frames if > 1 (photo)
[props.height]	number	Height of the image in pixels (photo/video)
[props.identifier]	Identifier	Identifier(s) for the image
[props.issued]	instant	Date/Time this version was made available
[props.modality]	string	The type of acquisition equipment/process. Accepts all values from http://hl7.org/fhir/ValueSet/media-modality
[props.note]	Annotation	Comments made about the media
[props.operator]	Reference	The person who generated the image
[props.partOf]	Reference	Part of referenced event
[props.reasonCode]	string	Why was event performed?. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-reason
[props.status]	string	preparation
[props.subject]	Reference	Who/What this Media is a record of
[props.type]	string	Classification of media as image, video, or audio. Accepts all values from http://hl7.org/fhir/ValueSet/media-type
[props.view]	string	Imaging view, e.g. Lateral or Antero-posterior. Accepts all values from http://hl7.org/fhir/ValueSet/media-view
[props.width]	number	Width of the image in pixels (photo/video)

---

builders.medication

medication(props)

Create a Medication resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.amount]	Ratio	Amount of drug in package
[props.batch]	BackboneElement	Details about packaged medications
[props.code]	string	Codes that identify this medication. Accepts all values from http://hl7.org/fhir/ValueSet/medication-codes
[props.form]	string	powder
[props.identifier]	Identifier	Business identifier for this medication
[props.ingredient]	BackboneElement	Active or inactive ingredient
[props.manufacturer]	Reference	Manufacturer of the item
[props.status]	string	active

---

builders.medicationAdministration

medicationAdministration(props)

Create a MedicationAdministration resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.category]	string	Type of medication usage. Accepts all values from http://hl7.org/fhir/ValueSet/medication-admin-category
[props.context]	Reference	Encounter or Episode of Care administered as part of
[props.device]	Reference	Device used to administer
[props.dosage]	BackboneElement	Details of how medication was taken
[props.effective]	dateTime | Period	Start and end time of administration
[props.eventHistory]	Reference	A list of events of interest in the lifecycle
[props.identifier]	Identifier	External identifier
[props.instantiates]	string	Instantiates protocol or definition
[props.medication]	string	What was administered. Accepts all values from http://hl7.org/fhir/ValueSet/medication-codes
[props.note]	Annotation	Information about the administration
[props.partOf]	Reference	Part of referenced event
[props.performer]	BackboneElement	Who performed the medication administration and what they did
[props.reasonCode]	string	Reason administration performed. Accepts all values from http://hl7.org/fhir/ValueSet/reason-medication-given-codes
[props.reasonReference]	Reference	Condition or observation that supports why the medication was administered
[props.request]	Reference	Request administration performed against
[props.status]	string	in-progress
[props.statusReason]	string	Reason administration not performed. Accepts all values from http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes
[props.subject]	Reference	Who received medication
[props.supportingInformation]	Reference	Additional information to support administration

---

builders.medicationDispense

medicationDispense(props)

Create a MedicationDispense resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.authorizingPrescription]	Reference	Medication order that authorizes the dispense
[props.category]	string	Type of medication dispense. Accepts all values from http://hl7.org/fhir/ValueSet/medicationdispense-category
[props.context]	Reference	Encounter / Episode associated with event
[props.daysSupply]	Quantity	Amount of medication expressed as a timing amount
[props.destination]	Reference	Where the medication was sent
[props.detectedIssue]	Reference	Clinical issue with action
[props.dosageInstruction]	Dosage	How the medication is to be used by the patient or administered by the caregiver
[props.eventHistory]	Reference	A list of relevant lifecycle events
[props.identifier]	Identifier	External identifier
[props.location]	Reference	Where the dispense occurred
[props.medication]	string	What medication was supplied. Accepts all values from http://hl7.org/fhir/ValueSet/medication-codes
[props.note]	Annotation	Information about the dispense
[props.partOf]	Reference	Event that dispense is part of
[props.performer]	BackboneElement	Who performed event
[props.quantity]	Quantity	Amount dispensed
[props.receiver]	Reference	Who collected the medication
[props.status]	string	preparation
[props.statusReason]	string	Why a dispense was not performed. Accepts all values from http://hl7.org/fhir/ValueSet/medicationdispense-status-reason
[props.subject]	Reference	Who the dispense is for
[props.substitution]	BackboneElement	Whether a substitution was performed on the dispense
[props.supportingInformation]	Reference	Information that supports the dispensing of the medication
[props.type]	string	Trial fill, partial fill, emergency fill, etc.. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ActPharmacySupplyType
[props.whenHandedOver]	dateTime	When product was given out
[props.whenPrepared]	dateTime	When product was packaged and reviewed

---

builders.medicationKnowledge

medicationKnowledge(props)

Create a MedicationKnowledge resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.administrationGuidelines]	BackboneElement	Guidelines for administration of the medication
[props.amount]	Quantity	Amount of drug in package
[props.associatedMedication]	Reference	A medication resource that is associated with this medication
[props.code]	string	Code that identifies this medication. Accepts all values from http://hl7.org/fhir/ValueSet/medication-codes
[props.contraindication]	Reference	Potential clinical issue with or between medication(s)
[props.cost]	BackboneElement	The pricing of the medication
[props.doseForm]	string	powder
[props.drugCharacteristic]	BackboneElement	Specifies descriptive properties of the medicine
[props.ingredient]	BackboneElement	Active or inactive ingredient
[props.intendedRoute]	string	The intended or approved route of administration. Accepts all values from http://hl7.org/fhir/ValueSet/route-codes
[props.kinetics]	BackboneElement	The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
[props.manufacturer]	Reference	Manufacturer of the item
[props.medicineClassification]	BackboneElement	Categorization of the medication within a formulary or classification system
[props.monitoringProgram]	BackboneElement	Program under which a medication is reviewed
[props.monograph]	BackboneElement	Associated documentation about the medication
[props.packaging]	BackboneElement	Details about packaged medications
[props.preparationInstruction]	markdown	The instructions for preparing the medication
[props.productType]	CodeableConcept	Category of the medication or product
[props.regulatory]	BackboneElement	Regulatory information about a medication
[props.relatedMedicationKnowledge]	BackboneElement	Associated or related medication information
[props.status]	string	active
[props.synonym]	string	Additional names for a medication

---

builders.medicationRequest

medicationRequest(props)

Create a MedicationRequest resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.authoredOn]	dateTime	When request was initially authored
[props.basedOn]	Reference	What request fulfills
[props.category]	string	Type of medication usage. Accepts all values from http://hl7.org/fhir/ValueSet/medicationrequest-category
[props.courseOfTherapyType]	string	Overall pattern of medication administration. Accepts all values from http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
[props.detectedIssue]	Reference	Clinical Issue with action
[props.dispenseRequest]	BackboneElement	Medication supply authorization
[props.doNotPerform]	boolean	True if request is prohibiting action
[props.dosageInstruction]	Dosage	How the medication should be taken
[props.encounter]	Reference	Encounter created as part of encounter/admission/stay
[props.eventHistory]	Reference	A list of events of interest in the lifecycle
[props.groupIdentifier]	Identifier	Composite request this is part of
[props.identifier]	Identifier	External ids for this request
[props.instantiatesCanonical]	canonical	Instantiates FHIR protocol or definition
[props.instantiatesUri]	string	Instantiates external protocol or definition
[props.insurance]	Reference	Associated insurance coverage
[props.intent]	string	proposal
[props.medication]	string	Medication to be taken. Accepts all values from http://hl7.org/fhir/ValueSet/medication-codes
[props.note]	Annotation	Information about the prescription
[props.performer]	Reference	Intended performer of administration
[props.performerType]	string	Desired kind of performer of the medication administration. Accepts all values from http://hl7.org/fhir/ValueSet/performer-role
[props.priorPrescription]	Reference	An order/prescription that is being replaced
[props.priority]	string	routine
[props.reasonCode]	string	Reason or indication for ordering or not ordering the medication. Accepts all values from http://hl7.org/fhir/ValueSet/condition-code
[props.reasonReference]	Reference	Condition or observation that supports why the prescription is being written
[props.recorder]	Reference	Person who entered the request
[props.reported]	boolean | Reference	Reported rather than primary record
[props.requester]	Reference	Who/What requested the Request
[props.status]	string	active
[props.statusReason]	string	Reason for current status. Accepts all values from http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
[props.subject]	Reference	Who or group medication request is for
[props.substitution]	BackboneElement	Any restrictions on medication substitution
[props.supportingInformation]	Reference	Information to support ordering of the medication

---

builders.medicationStatement

medicationStatement(props)

Create a MedicationStatement resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.basedOn]	Reference	Fulfils plan, proposal or order
[props.category]	string	Type of medication usage. Accepts all values from http://hl7.org/fhir/ValueSet/medication-statement-category
[props.context]	Reference	Encounter / Episode associated with MedicationStatement
[props.dateAsserted]	dateTime	When the statement was asserted?
[props.derivedFrom]	Reference	Additional supporting information
[props.dosage]	Dosage	Details of how medication is/was taken or should be taken
[props.effective]	dateTime | Period	The date/time or interval when the medication is/was/will be taken
[props.identifier]	Identifier	External identifier
[props.informationSource]	Reference	Person or organization that provided the information about the taking of this medication
[props.medication]	string	What medication was taken. Accepts all values from http://hl7.org/fhir/ValueSet/medication-codes
[props.note]	Annotation	Further information about the statement
[props.partOf]	Reference	Part of referenced event
[props.reasonCode]	string	Reason for why the medication is being/was taken. Accepts all values from http://hl7.org/fhir/ValueSet/condition-code
[props.reasonReference]	Reference	Condition or observation that supports why the medication is being/was taken
[props.status]	string	active
[props.statusReason]	string	Reason for current status. Accepts all values from http://hl7.org/fhir/ValueSet/reason-medication-status-codes
[props.subject]	Reference	Who is/was taking the medication

---

builders.medicinalProductDefinition

medicinalProductDefinition(props)

Create a MedicinalProductDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.additionalMonitoringIndicator]	string	Whether the Medicinal Product is subject to additional monitoring for regulatory reasons. Accepts all values from http://hl7.org/fhir/ValueSet/medicinal-product-additional-monitoring
[props.attachedDocument]	Reference	Additional documentation about the medicinal product
[props.characteristic]	BackboneElement	Key product features such as "sugar free", "modified release"
[props.classification]	string	Allows the product to be classified by various systems. Accepts all values from http://hl7.org/fhir/ValueSet/product-classification-codes
[props.clinicalTrial]	Reference	Clinical trials or studies that this product is involved in
[props.code]	string	A code that this product is known by, within some formal terminology. Accepts all values from http://hl7.org/fhir/ValueSet/medication-codes
[props.combinedPharmaceuticalDoseForm]	string	The dose form for a single part product, or combined form of a multiple part product. Accepts all values from http://hl7.org/fhir/ValueSet/combined-dose-form
[props.contact]	BackboneElement	A product specific contact, person (in a role), or an organization
[props.crossReference]	BackboneElement	Reference to another product, e.g. for linking authorised to investigational product
[props.description]	markdown	General description of this product
[props.domain]	string	If this medicine applies to human or veterinary uses. Accepts all values from http://hl7.org/fhir/ValueSet/medicinal-product-domain
[props.identifier]	Identifier	Business identifier for this product. Could be an MPID
[props.impurity]	string	Any component of the drug product which is not the chemical entity defined as the drug substance, or an excipient in the drug product. Accepts all values from http://hl7.org/fhir/ValueSet/substance-codes
[props.indication]	markdown	Description of indication(s) for this product, used when structured indications are not required
[props.ingredient]	string	The ingredients of this medicinal product - when not detailed in other resources. Accepts all values from http://hl7.org/fhir/ValueSet/substance-codes
[props.legalStatusOfSupply]	string	The legal status of supply of the medicinal product as classified by the regulator. Accepts all values from http://hl7.org/fhir/ValueSet/legal-status-of-supply
[props.marketingStatus]	MarketingStatus	Marketing status of the medicinal product, in contrast to marketing authorization
[props.masterFile]	Reference	A master file for the medicinal product (e.g. Pharmacovigilance System Master File)
[props.name]	BackboneElement	The product's name, including full name and possibly coded parts
[props.operation]	BackboneElement	A manufacturing or administrative process for the medicinal product
[props.packagedMedicinalProduct]	string	Package type for the product. Accepts all values from http://hl7.org/fhir/ValueSet/medicinal-product-package-type
[props.pediatricUseIndicator]	string	If authorised for use in children. Accepts all values from http://hl7.org/fhir/ValueSet/medicinal-product-pediatric-use
[props.route]	string	The path by which the product is taken into or makes contact with the body. Accepts all values from http://hl7.org/fhir/ValueSet/route-codes
[props.specialMeasures]	string	Whether the Medicinal Product is subject to special measures for regulatory reasons. Accepts all values from http://hl7.org/fhir/ValueSet/medicinal-product-special-measures
[props.status]	string	The status within the lifecycle of this product record. Accepts all values from http://hl7.org/fhir/ValueSet/publication-status
[props.statusDate]	dateTime	The date at which the given status became applicable
[props.type]	string	Regulatory type, e.g. Investigational or Authorized. Accepts all values from http://hl7.org/fhir/ValueSet/medicinal-product-type
[props.version]	string	A business identifier relating to a specific version of the product

---

builders.molecularSequence

molecularSequence(props)

Create a MolecularSequence resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.coordinateSystem]	integer	Base number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)
[props.device]	Reference	The method for sequencing
[props.identifier]	Identifier	Unique ID for this particular sequence. This is a FHIR-defined id
[props.observedSeq]	string	Sequence that was observed
[props.patient]	Reference	Who and/or what this is about
[props.performer]	Reference	Who should be responsible for test result
[props.pointer]	Reference	Pointer to next atomic sequence
[props.quality]	BackboneElement	An set of value as quality of sequence
[props.quantity]	Quantity	The number of copies of the sequence of interest. (RNASeq)
[props.readCoverage]	integer	Average number of reads representing a given nucleotide in the reconstructed sequence
[props.referenceSeq]	BackboneElement	A sequence used as reference
[props.repository]	BackboneElement	External repository which contains detailed report related with observedSeq in this resource
[props.specimen]	Reference	Specimen used for sequencing
[props.structureVariant]	BackboneElement	Structural variant
[props.type]	string	aa
[props.variant]	BackboneElement	Variant in sequence

---

builders.nutritionOrder

nutritionOrder(props)

Create a NutritionOrder resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.allergyIntolerance]	Reference	List of the patient's food and nutrition-related allergies and intolerances
[props.dateTime]	dateTime	Date and time the nutrition order was requested
[props.encounter]	Reference	The encounter associated with this nutrition order
[props.enteralFormula]	BackboneElement	Enteral formula components
[props.excludeFoodModifier]	string	Order-specific modifier about the type of food that should not be given. Accepts all values from http://hl7.org/fhir/ValueSet/food-type
[props.foodPreferenceModifier]	string	Order-specific modifier about the type of food that should be given. Accepts all values from http://hl7.org/fhir/ValueSet/encounter-diet
[props.identifier]	Identifier	Identifiers assigned to this order
[props.instantiates]	string	Instantiates protocol or definition
[props.instantiatesCanonical]	canonical	Instantiates FHIR protocol or definition
[props.instantiatesUri]	string	Instantiates external protocol or definition
[props.intent]	string	proposal
[props.note]	Annotation	Comments
[props.oralDiet]	BackboneElement	Oral diet components
[props.orderer]	Reference	Who ordered the diet, formula or nutritional supplement
[props.patient]	Reference	The person who requires the diet, formula or nutritional supplement
[props.status]	string	draft
[props.supplement]	BackboneElement	Supplement components

---

builders.nutritionProduct

nutritionProduct(props)

Create a NutritionProduct resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.category]	string	A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc). Accepts all values from http://hl7.org/fhir/ValueSet/nutrition-product-category
[props.code]	string	A code designating a specific type of nutritional product. Accepts all values from http://hl7.org/fhir/ValueSet/edible-substance-type
[props.ingredient]	BackboneElement	Ingredients contained in this product
[props.instance]	BackboneElement	One or several physical instances or occurrences of the nutrition product
[props.knownAllergen]	string	Known or suspected allergens that are a part of this product. Accepts all values from http://hl7.org/fhir/ValueSet/allergen-class
[props.manufacturer]	Reference	Manufacturer, representative or officially responsible for the product
[props.note]	Annotation	Comments made about the product
[props.nutrient]	BackboneElement	The product's nutritional information expressed by the nutrients
[props.productCharacteristic]	BackboneElement	Specifies descriptive properties of the nutrition product
[props.status]	string	active

---

builders.observation

observation(props)

Create a Observation resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.basedOn]	Reference	Fulfills plan, proposal or order
[props.bodySite]	string	Observed body part. Accepts all values from http://hl7.org/fhir/ValueSet/body-site
[props.category]	string	Classification of type of observation. Accepts all values from http://hl7.org/fhir/ValueSet/observation-category
[props.code]	string	Type of observation (code / type). Accepts all values from http://hl7.org/fhir/ValueSet/observation-codes
[props.component]	BackboneElement	Component results
[props.dataAbsentReason]	string	Why the result is missing. Accepts all values from http://hl7.org/fhir/ValueSet/data-absent-reason
[props.derivedFrom]	Reference	Related measurements the observation is made from
[props.device]	Reference	(Measurement) Device
[props.effective]	dateTime | Period | Timing | instant	Clinically relevant time/time-period for observation
[props.encounter]	Reference	Healthcare event during which this observation is made
[props.focus]	Reference	What the observation is about, when it is not about the subject of record
[props.hasMember]	Reference	Related resource that belongs to the Observation group
[props.identifier]	Identifier	Business Identifier for observation
[props.interpretation]	string	High, low, normal, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/observation-interpretation
[props.issued]	instant	Date/Time this version was made available
[props.method]	string	How it was done. Accepts all values from http://hl7.org/fhir/ValueSet/observation-methods
[props.note]	Annotation	Comments about the observation
[props.partOf]	Reference	Part of referenced event
[props.performer]	Reference	Who is responsible for the observation
[props.referenceRange]	BackboneElement	Provides guide for interpretation
[props.specimen]	Reference	Specimen used for this observation
[props.status]	string	registered
[props.subject]	Reference	Who and/or what the observation is about
[props.value]	Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period	Actual result

---

builders.observationDefinition

observationDefinition(props)

Create a ObservationDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.abnormalCodedValueSet]	Reference	Value set of abnormal coded values for the observations conforming to this ObservationDefinition
[props.category]	string	Category of observation. Accepts all values from http://hl7.org/fhir/ValueSet/observation-category
[props.code]	string	Type of observation (code / type). Accepts all values from http://hl7.org/fhir/ValueSet/observation-codes
[props.criticalCodedValueSet]	Reference	Value set of critical coded values for the observations conforming to this ObservationDefinition
[props.identifier]	Identifier	Business identifier for this ObservationDefinition instance
[props.method]	string	Method used to produce the observation. Accepts all values from http://hl7.org/fhir/ValueSet/observation-methods
[props.multipleResultsAllowed]	boolean	Multiple results allowed
[props.normalCodedValueSet]	Reference	Value set of normal coded values for the observations conforming to this ObservationDefinition
[props.permittedDataType]	string	Quantity
[props.preferredReportName]	string	Preferred report name
[props.qualifiedInterval]	BackboneElement	Qualified range for continuous and ordinal observation results
[props.quantitativeDetails]	BackboneElement	Characteristics of quantitative results
[props.validCodedValueSet]	Reference	Value set of valid coded values for the observations conforming to this ObservationDefinition

---

builders.organization

organization(props)

Create a Organization resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.active]	boolean	Whether the organization's record is still in active use
[props.address]	Address	An address for the organization
[props.alias]	string	A list of alternate names that the organization is known as, or was known as in the past
[props.contact]	BackboneElement	Contact for the organization for a certain purpose
[props.endpoint]	Reference	Technical endpoints providing access to services operated for the organization
[props.identifier]	Identifier	Identifies this organization across multiple systems
[props.name]	string	Name used for the organization
[props.partOf]	Reference	The organization of which this organization forms a part
[props.telecom]	ContactPoint	A contact detail for the organization
[props.type]	string	Kind of organization. Accepts all values from http://hl7.org/fhir/ValueSet/organization-type

---

builders.organizationAffiliation

organizationAffiliation(props)

Create a OrganizationAffiliation resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.active]	boolean	Whether this organization affiliation record is in active use
[props.code]	string	Definition of the role the participatingOrganization plays. Accepts all values from http://hl7.org/fhir/ValueSet/organization-role
[props.endpoint]	Reference	Technical endpoints providing access to services operated for this role
[props.healthcareService]	Reference	Healthcare services provided through the role
[props.identifier]	Identifier	Business identifiers that are specific to this role
[props.location]	Reference	The location(s) at which the role occurs
[props.network]	Reference	Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
[props.organization]	Reference	Organization where the role is available
[props.participatingOrganization]	Reference	Organization that provides/performs the role (e.g. providing services or is a member of)
[props.period]	Period	The period during which the participatingOrganization is affiliated with the primary organization
[props.specialty]	string	Specific specialty of the participatingOrganization in the context of the role. Accepts all values from http://hl7.org/fhir/ValueSet/c80-practice-codes
[props.telecom]	ContactPoint	Contact details at the participatingOrganization relevant to this Affiliation

---

builders.packagedProductDefinition

packagedProductDefinition(props)

Create a PackagedProductDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.characteristic]	string	Allows the key features to be recorded, such as "hospital pack", "nurse prescribable". Accepts all values from http://hl7.org/fhir/ValueSet/package-characteristic
[props.containedItemQuantity]	Quantity	A total of the complete count of contained items of a particular type/form, independent of sub-packaging or organization. This can be considered as the pack size
[props.copackagedIndicator]	boolean	If the drug product is supplied with another item such as a diluent or adjuvant
[props.description]	markdown	Textual description. Note that this is not the name of the package or product
[props.identifier]	Identifier	A unique identifier for this package as whole
[props.legalStatusOfSupply]	BackboneElement	The legal status of supply of the packaged item as classified by the regulator
[props.manufacturer]	Reference	Manufacturer of this package type (multiple means these are all possible manufacturers)
[props.marketingStatus]	MarketingStatus	Allows specifying that an item is on the market for sale, or that it is not available, and the dates and locations associated
[props.name]	string	A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
[props.package]	BackboneElement	A packaging item, as a container for medically related items, possibly with other packaging items within, or a packaging component, such as bottle cap
[props.packageFor]	Reference	The product that this is a pack for
[props.status]	string	The status within the lifecycle of this item. High level - not intended to duplicate details elsewhere e.g. legal status, or authorization/marketing status. Accepts all values from http://hl7.org/fhir/ValueSet/publication-status
[props.statusDate]	dateTime	The date at which the given status became applicable
[props.type]	string	A high level category e.g. medicinal product, raw material, shipping container etc. Accepts all values from http://hl7.org/fhir/ValueSet/package-type

---

builders.patient

patient(props)

Create a Patient resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.active]	boolean	Whether this patient's record is in active use
[props.address]	Address	An address for the individual
[props.birthDate]	date	The date of birth for the individual
[props.communication]	BackboneElement	A language which may be used to communicate with the patient about his or her health
[props.contact]	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
[props.deceased]	boolean | dateTime	Indicates if the individual is deceased or not
[props.gender]	string	male
[props.generalPractitioner]	Reference	Patient's nominated primary care provider
[props.identifier]	Identifier	An identifier for this patient
[props.link]	BackboneElement	Link to another patient resource that concerns the same actual person
[props.managingOrganization]	Reference	Organization that is the custodian of the patient record
[props.maritalStatus]	string	Marital (civil) status of a patient. Accepts all values from http://hl7.org/fhir/ValueSet/marital-status
[props.multipleBirth]	boolean | integer	Whether patient is part of a multiple birth
[props.name]	HumanName	A name associated with the patient
[props.photo]	Attachment	Image of the patient
[props.telecom]	ContactPoint	A contact detail for the individual

---

builders.paymentNotice

paymentNotice(props)

Create a PaymentNotice resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.amount]	Money	Monetary amount of the payment
[props.created]	dateTime	Creation date
[props.identifier]	Identifier	Business Identifier for the payment noctice
[props.payee]	Reference	Party being paid
[props.payment]	Reference	Payment reference
[props.paymentDate]	date	Payment or clearing date
[props.paymentStatus]	string	Issued or cleared Status of the payment. Accepts all values from http://hl7.org/fhir/ValueSet/payment-status
[props.provider]	Reference	Responsible practitioner
[props.recipient]	Reference	Party being notified
[props.request]	Reference	Request reference
[props.response]	Reference	Response reference
[props.status]	string	active

---

builders.paymentReconciliation

paymentReconciliation(props)

Create a PaymentReconciliation resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.created]	dateTime	Creation date
[props.detail]	BackboneElement	Settlement particulars
[props.disposition]	string	Disposition message
[props.formCode]	string	Printed form identifier. Accepts all values from http://hl7.org/fhir/ValueSet/forms
[props.identifier]	Identifier	Business Identifier for a payment reconciliation
[props.outcome]	string	queued
[props.paymentAmount]	Money	Total amount of Payment
[props.paymentDate]	date	When payment issued
[props.paymentIdentifier]	Identifier	Business identifier for the payment
[props.paymentIssuer]	Reference	Party generating payment
[props.period]	Period	Period covered
[props.processNote]	BackboneElement	Note concerning processing
[props.request]	Reference	Reference to requesting resource
[props.requestor]	Reference	Responsible practitioner
[props.status]	string	active

---

builders.person

person(props)

Create a Person resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.active]	boolean	This person's record is in active use
[props.address]	Address	One or more addresses for the person
[props.birthDate]	date	The date on which the person was born
[props.gender]	string	male
[props.identifier]	Identifier	A human identifier for this person
[props.link]	BackboneElement	Link to a resource that concerns the same actual person
[props.managingOrganization]	Reference	The organization that is the custodian of the person record
[props.name]	HumanName	A name associated with the person
[props.photo]	Attachment	Image of the person
[props.telecom]	ContactPoint	A contact detail for the person

---

builders.planDefinition

planDefinition(props)

Create a PlanDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.action]	BackboneElement	Action defined by the plan
[props.approvalDate]	date	When the plan definition was approved by publisher
[props.author]	ContactDetail	Who authored the content
[props.contact]	ContactDetail	Contact details for the publisher
[props.copyright]	markdown	Use and/or publishing restrictions
[props.date]	dateTime	Date last changed
[props.description]	markdown	Natural language description of the plan definition
[props.editor]	ContactDetail	Who edited the content
[props.effectivePeriod]	Period	When the plan definition is expected to be used
[props.endorser]	ContactDetail	Who endorsed the content
[props.experimental]	boolean	For testing purposes, not real usage
[props.goal]	BackboneElement	What the plan is trying to accomplish
[props.identifier]	Identifier	Additional identifier for the plan definition
[props.jurisdiction]	string	Intended jurisdiction for plan definition (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.lastReviewDate]	date	When the plan definition was last reviewed
[props.library]	canonical	Logic used by the plan definition
[props.name]	string	Name for this plan definition (computer friendly)
[props.publisher]	string	Name of the publisher (organization or individual)
[props.purpose]	markdown	Why this plan definition is defined
[props.relatedArtifact]	RelatedArtifact	Additional documentation, citations
[props.reviewer]	ContactDetail	Who reviewed the content
[props.status]	string	draft
[props.subject]	string	Type of individual the plan definition is focused on. Accepts all values from http://hl7.org/fhir/ValueSet/subject-type
[props.subtitle]	string	Subordinate title of the plan definition
[props.title]	string	Name for this plan definition (human friendly)
[props.topic]	string	E.g. Education, Treatment, Assessment. Accepts all values from http://hl7.org/fhir/ValueSet/definition-topic
[props.type]	string	order-set
[props.url]	string	Canonical identifier for this plan definition, represented as a URI (globally unique)
[props.usage]	string	Describes the clinical usage of the plan
[props.useContext]	UsageContext	The context that the content is intended to support
[props.version]	string	Business version of the plan definition

---

builders.practitioner

practitioner(props)

Create a Practitioner resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.active]	boolean	Whether this practitioner's record is in active use
[props.address]	Address	Address(es) of the practitioner that are not role specific (typically home address)
[props.birthDate]	date	The date on which the practitioner was born
[props.communication]	string	A language the practitioner can use in patient communication. Accepts all values from http://hl7.org/fhir/ValueSet/languages
[props.gender]	string	male
[props.identifier]	Identifier	An identifier for the person as this agent
[props.name]	HumanName	The name(s) associated with the practitioner
[props.photo]	Attachment	Image of the person
[props.qualification]	BackboneElement	Certification, licenses, or training pertaining to the provision of care
[props.telecom]	ContactPoint	A contact detail for the practitioner (that apply to all roles)

---

builders.practitionerRole

practitionerRole(props)

Create a PractitionerRole resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.active]	boolean	Whether this practitioner role record is in active use
[props.availabilityExceptions]	string	Description of availability exceptions
[props.availableTime]	BackboneElement	Times the Service Site is available
[props.code]	string	Roles which this practitioner may perform. Accepts all values from http://hl7.org/fhir/ValueSet/practitioner-role
[props.endpoint]	Reference	Technical endpoints providing access to services operated for the practitioner with this role
[props.healthcareService]	Reference	The list of healthcare services that this worker provides for this role's Organization/Location(s)
[props.identifier]	Identifier	Business Identifiers that are specific to a role/location
[props.location]	Reference	The location(s) at which this practitioner provides care
[props.notAvailable]	BackboneElement	Not available during this time due to provided reason
[props.organization]	Reference	Organization where the roles are available
[props.period]	Period	The period during which the practitioner is authorized to perform in these role(s)
[props.practitioner]	Reference	Practitioner that is able to provide the defined services for the organization
[props.specialty]	string	Specific specialty of the practitioner. Accepts all values from http://hl7.org/fhir/ValueSet/c80-practice-codes
[props.telecom]	ContactPoint	Contact details that are specific to the role/location/service

---

builders.procedure

procedure(props)

Create a Procedure resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.asserter]	Reference	Person who asserts this procedure
[props.basedOn]	Reference	A request for this procedure
[props.bodySite]	string	Target body sites. Accepts all values from http://hl7.org/fhir/ValueSet/body-site
[props.category]	string	Classification of the procedure. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-category
[props.code]	string	Identification of the procedure. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-code
[props.complication]	string	Complication following the procedure. Accepts all values from http://hl7.org/fhir/ValueSet/condition-code
[props.complicationDetail]	Reference	A condition that is a result of the procedure
[props.encounter]	Reference	Encounter created as part of
[props.focalDevice]	BackboneElement	Manipulated, implanted, or removed device
[props.followUp]	string	Instructions for follow up. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-followup
[props.identifier]	Identifier	External Identifiers for this procedure
[props.instantiatesCanonical]	canonical	Instantiates FHIR protocol or definition
[props.instantiatesUri]	string	Instantiates external protocol or definition
[props.location]	Reference	Where the procedure happened
[props.note]	Annotation	Additional information about the procedure
[props.outcome]	string	The result of procedure. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-outcome
[props.partOf]	Reference	Part of referenced event
[props.performed]	dateTime | Period | string | Age | Range	When the procedure was performed
[props.performer]	BackboneElement	The people who performed the procedure
[props.reasonCode]	string	Coded reason procedure performed. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-reason
[props.reasonReference]	Reference	The justification that the procedure was performed
[props.recorder]	Reference	Who recorded the procedure
[props.report]	Reference	Any report resulting from the procedure
[props.status]	string	preparation
[props.statusReason]	string	Reason for current status. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-not-performed-reason
[props.subject]	Reference	Who the procedure was performed on
[props.usedCode]	string	Coded items used during the procedure. Accepts all values from http://hl7.org/fhir/ValueSet/device-kind
[props.usedReference]	Reference	Items used during procedure

---

builders.questionnaire

questionnaire(props)

Create a Questionnaire resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.approvalDate]	date	When the questionnaire was approved by publisher
[props.code]	string	Concept that represents the overall questionnaire. Accepts all values from http://hl7.org/fhir/ValueSet/questionnaire-questions
[props.contact]	ContactDetail	Contact details for the publisher
[props.copyright]	markdown	Use and/or publishing restrictions
[props.date]	dateTime	Date last changed
[props.derivedFrom]	canonical	Instantiates protocol or definition
[props.description]	markdown	Natural language description of the questionnaire
[props.effectivePeriod]	Period	When the questionnaire is expected to be used
[props.experimental]	boolean	For testing purposes, not real usage
[props.identifier]	Identifier	Additional identifier for the questionnaire
[props.item]	BackboneElement	Questions and sections within the Questionnaire
[props.jurisdiction]	string	Intended jurisdiction for questionnaire (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.lastReviewDate]	date	When the questionnaire was last reviewed
[props.name]	string	Name for this questionnaire (computer friendly)
[props.publisher]	string	Name of the publisher (organization or individual)
[props.purpose]	markdown	Why this questionnaire is defined
[props.status]	string	draft
[props.subjectType]	string	Resource that can be subject of QuestionnaireResponse. Accepts all values from http://hl7.org/fhir/ValueSet/resource-types
[props.title]	string	Name for this questionnaire (human friendly)
[props.url]	string	Canonical identifier for this questionnaire, represented as a URI (globally unique)
[props.useContext]	UsageContext	The context that the content is intended to support
[props.version]	string	Business version of the questionnaire

---

builders.questionnaireResponse

questionnaireResponse(props)

Create a QuestionnaireResponse resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.author]	Reference	Person who received and recorded the answers
[props.authored]	dateTime	Date the answers were gathered
[props.basedOn]	Reference	Request fulfilled by this QuestionnaireResponse
[props.encounter]	Reference	Encounter created as part of
[props.identifier]	Identifier	Unique id for this set of answers
[props.item]	BackboneElement	Groups and questions
[props.partOf]	Reference	Part of this action
[props.questionnaire]	canonical	Form being answered
[props.source]	Reference	The person who answered the questions
[props.status]	string	in-progress
[props.subject]	Reference	The subject of the questions

---

builders.regulatedAuthorization

regulatedAuthorization(props)

Create a RegulatedAuthorization resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.basis]	string	The legal/regulatory framework or reasons under which this authorization is granted. Accepts all values from http://hl7.org/fhir/ValueSet/regulated-authorization-basis
[props.case]	BackboneElement	The case or regulatory procedure for granting or amending a regulated authorization. Note: This area is subject to ongoing review and the workgroup is seeking implementer feedback on its use (see link at bottom of page)
[props.description]	markdown	General textual supporting information
[props.holder]	Reference	The organization that has been granted this authorization, by the regulator
[props.identifier]	Identifier	Business identifier for the authorization, typically assigned by the authorizing body
[props.indication]	CodeableReference	Condition for which the use of the regulated product applies
[props.intendedUse]	string	The intended use of the product, e.g. prevention, treatment. Accepts all values from http://hl7.org/fhir/ValueSet/product-intended-use
[props.region]	string	The territory in which the authorization has been granted. Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.regulator]	Reference	The regulatory authority or authorizing body granting the authorization
[props.status]	string	The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications. Accepts all values from http://hl7.org/fhir/ValueSet/publication-status
[props.statusDate]	dateTime	The date at which the current status was assigned
[props.subject]	Reference	The product type, treatment, facility or activity that is being authorized
[props.type]	string	Overall type of this authorization, for example drug marketing approval, orphan drug designation. Accepts all values from http://hl7.org/fhir/ValueSet/regulated-authorization-type
[props.validityPeriod]	Period	The time period in which the regulatory approval etc. is in effect, e.g. a Marketing Authorization includes the date of authorization and/or expiration date

---

builders.relatedPerson

relatedPerson(props)

Create a RelatedPerson resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.active]	boolean	Whether this related person's record is in active use
[props.address]	Address	Address where the related person can be contacted or visited
[props.birthDate]	date	The date on which the related person was born
[props.communication]	BackboneElement	A language which may be used to communicate with about the patient's health
[props.gender]	string	male
[props.identifier]	Identifier	A human identifier for this person
[props.name]	HumanName	A name associated with the person
[props.patient]	Reference	The patient this person is related to
[props.period]	Period	Period of time that this relationship is considered valid
[props.photo]	Attachment	Image of the person
[props.relationship]	string	The nature of the relationship. Accepts all values from http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
[props.telecom]	ContactPoint	A contact detail for the person

---

builders.requestGroup

requestGroup(props)

Create a RequestGroup resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.action]	BackboneElement	Proposed actions, if any
[props.author]	Reference	Device or practitioner that authored the request group
[props.authoredOn]	dateTime	When the request group was authored
[props.basedOn]	Reference	Fulfills plan, proposal, or order
[props.code]	CodeableConcept	What's being requested/ordered
[props.encounter]	Reference	Created as part of
[props.groupIdentifier]	Identifier	Composite request this is part of
[props.identifier]	Identifier	Business identifier
[props.instantiatesCanonical]	canonical	Instantiates FHIR protocol or definition
[props.instantiatesUri]	string	Instantiates external protocol or definition
[props.intent]	string	proposal
[props.note]	Annotation	Additional notes about the response
[props.priority]	string	routine
[props.reasonCode]	CodeableConcept	Why the request group is needed
[props.reasonReference]	Reference	Why the request group is needed
[props.replaces]	Reference	Request(s) replaced by this request
[props.status]	string	draft
[props.subject]	Reference	Who the request group is about

---

builders.researchDefinition

researchDefinition(props)

Create a ResearchDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.approvalDate]	date	When the research definition was approved by publisher
[props.author]	ContactDetail	Who authored the content
[props.comment]	string	Used for footnotes or explanatory notes
[props.contact]	ContactDetail	Contact details for the publisher
[props.copyright]	markdown	Use and/or publishing restrictions
[props.date]	dateTime	Date last changed
[props.description]	markdown	Natural language description of the research definition
[props.editor]	ContactDetail	Who edited the content
[props.effectivePeriod]	Period	When the research definition is expected to be used
[props.endorser]	ContactDetail	Who endorsed the content
[props.experimental]	boolean	For testing purposes, not real usage
[props.exposure]	Reference	What exposure?
[props.exposureAlternative]	Reference	What alternative exposure state?
[props.identifier]	Identifier	Additional identifier for the research definition
[props.jurisdiction]	string	Intended jurisdiction for research definition (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.lastReviewDate]	date	When the research definition was last reviewed
[props.library]	canonical	Logic used by the ResearchDefinition
[props.name]	string	Name for this research definition (computer friendly)
[props.outcome]	Reference	What outcome?
[props.population]	Reference	What population?
[props.publisher]	string	Name of the publisher (organization or individual)
[props.purpose]	markdown	Why this research definition is defined
[props.relatedArtifact]	RelatedArtifact	Additional documentation, citations, etc.
[props.reviewer]	ContactDetail	Who reviewed the content
[props.shortTitle]	string	Title for use in informal contexts
[props.status]	string	draft
[props.subject]	string	E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. Accepts all values from http://hl7.org/fhir/ValueSet/subject-type
[props.subtitle]	string	Subordinate title of the ResearchDefinition
[props.title]	string	Name for this research definition (human friendly)
[props.topic]	string	The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/definition-topic
[props.url]	string	Canonical identifier for this research definition, represented as a URI (globally unique)
[props.usage]	string	Describes the clinical usage of the ResearchDefinition
[props.useContext]	UsageContext	The context that the content is intended to support
[props.version]	string	Business version of the research definition

---

builders.researchElementDefinition

researchElementDefinition(props)

Create a ResearchElementDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.approvalDate]	date	When the research element definition was approved by publisher
[props.author]	ContactDetail	Who authored the content
[props.characteristic]	BackboneElement	What defines the members of the research element
[props.comment]	string	Used for footnotes or explanatory notes
[props.contact]	ContactDetail	Contact details for the publisher
[props.copyright]	markdown	Use and/or publishing restrictions
[props.date]	dateTime	Date last changed
[props.description]	markdown	Natural language description of the research element definition
[props.editor]	ContactDetail	Who edited the content
[props.effectivePeriod]	Period	When the research element definition is expected to be used
[props.endorser]	ContactDetail	Who endorsed the content
[props.experimental]	boolean	For testing purposes, not real usage
[props.identifier]	Identifier	Additional identifier for the research element definition
[props.jurisdiction]	string	Intended jurisdiction for research element definition (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.lastReviewDate]	date	When the research element definition was last reviewed
[props.library]	canonical	Logic used by the ResearchElementDefinition
[props.name]	string	Name for this research element definition (computer friendly)
[props.publisher]	string	Name of the publisher (organization or individual)
[props.purpose]	markdown	Why this research element definition is defined
[props.relatedArtifact]	RelatedArtifact	Additional documentation, citations, etc.
[props.reviewer]	ContactDetail	Who reviewed the content
[props.shortTitle]	string	Title for use in informal contexts
[props.status]	string	draft
[props.subject]	string	E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. Accepts all values from http://hl7.org/fhir/ValueSet/subject-type
[props.subtitle]	string	Subordinate title of the ResearchElementDefinition
[props.title]	string	Name for this research element definition (human friendly)
[props.topic]	string	The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/definition-topic
[props.type]	string	population
[props.url]	string	Canonical identifier for this research element definition, represented as a URI (globally unique)
[props.usage]	string	Describes the clinical usage of the ResearchElementDefinition
[props.useContext]	UsageContext	The context that the content is intended to support
[props.variableType]	string	dichotomous
[props.version]	string	Business version of the research element definition

---

builders.researchStudy

researchStudy(props)

Create a ResearchStudy resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.arm]	BackboneElement	Defined path through the study for a subject
[props.category]	CodeableConcept	Classifications for the study
[props.condition]	string	Condition being studied. Accepts all values from http://hl7.org/fhir/ValueSet/condition-code
[props.contact]	ContactDetail	Contact details for the study
[props.description]	markdown	What this is study doing
[props.enrollment]	Reference	Inclusion & exclusion criteria
[props.focus]	CodeableConcept	Drugs, devices, etc. under study
[props.identifier]	Identifier	Business Identifier for study
[props.keyword]	CodeableConcept	Used to search for the study
[props.location]	string	Geographic region(s) for study. Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.note]	Annotation	Comments made about the study
[props.objective]	BackboneElement	A goal for the study
[props.partOf]	Reference	Part of larger study
[props.period]	Period	When the study began and ended
[props.phase]	string	n-a
[props.primaryPurposeType]	string	treatment
[props.principalInvestigator]	Reference	Researcher who oversees multiple aspects of the study
[props.protocol]	Reference	Steps followed in executing study
[props.reasonStopped]	string	accrual-goal-met
[props.relatedArtifact]	RelatedArtifact	References and dependencies
[props.site]	Reference	Facility where study activities are conducted
[props.sponsor]	Reference	Organization that initiates and is legally responsible for the study
[props.status]	string	active
[props.title]	string	Name for this study

---

builders.researchSubject

researchSubject(props)

Create a ResearchSubject resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.actualArm]	string	What path was followed
[props.assignedArm]	string	What path should be followed
[props.consent]	Reference	Agreement to participate in study
[props.identifier]	Identifier	Business Identifier for research subject in a study
[props.individual]	Reference	Who is part of study
[props.period]	Period	Start and end of participation
[props.status]	string	candidate
[props.study]	Reference	Study subject is part of

---

builders.riskAssessment

riskAssessment(props)

Create a RiskAssessment resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.basedOn]	Reference	Request fulfilled by this assessment
[props.basis]	Reference	Information used in assessment
[props.code]	CodeableConcept	Type of assessment
[props.condition]	Reference	Condition assessed
[props.encounter]	Reference	Where was assessment performed?
[props.identifier]	Identifier	Unique identifier for the assessment
[props.method]	CodeableConcept	Evaluation mechanism
[props.mitigation]	string	How to reduce risk
[props.note]	Annotation	Comments on the risk assessment
[props.occurrence]	dateTime | Period	When was assessment made?
[props.parent]	Reference	Part of this occurrence
[props.performer]	Reference	Who did assessment?
[props.prediction]	BackboneElement	Outcome predicted
[props.reasonCode]	CodeableConcept	Why the assessment was necessary?
[props.reasonReference]	Reference	Why the assessment was necessary?
[props.status]	string	registered
[props.subject]	Reference	Who/what does assessment apply to?

---

builders.schedule

schedule(props)

Create a Schedule resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.active]	boolean	Whether this schedule is in active use
[props.actor]	Reference	Resource(s) that availability information is being provided for
[props.comment]	string	Comments on availability
[props.identifier]	Identifier	External Ids for this item
[props.planningHorizon]	Period	Period of time covered by schedule
[props.serviceCategory]	string	High-level category. Accepts all values from http://hl7.org/fhir/ValueSet/service-category
[props.serviceType]	string	Specific service. Accepts all values from http://hl7.org/fhir/ValueSet/service-type
[props.specialty]	string	Type of specialty needed. Accepts all values from http://hl7.org/fhir/ValueSet/c80-practice-codes

---

builders.serviceRequest

serviceRequest(props)

Create a ServiceRequest resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.asNeeded]	string	Preconditions for service. Accepts all values from http://hl7.org/fhir/ValueSet/medication-as-needed-reason
[props.authoredOn]	dateTime	Date request signed
[props.basedOn]	Reference	What request fulfills
[props.bodySite]	string	Location on Body. Accepts all values from http://hl7.org/fhir/ValueSet/body-site
[props.category]	string	Classification of service. Accepts all values from http://hl7.org/fhir/ValueSet/servicerequest-category
[props.code]	string	What is being requested/ordered. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-code
[props.doNotPerform]	boolean	True if service/procedure should not be performed
[props.encounter]	Reference	Encounter in which the request was created
[props.identifier]	Identifier	Identifiers assigned to this order
[props.instantiatesCanonical]	canonical	Instantiates FHIR protocol or definition
[props.instantiatesUri]	string	Instantiates external protocol or definition
[props.insurance]	Reference	Associated insurance coverage
[props.intent]	string	proposal
[props.locationCode]	string	Requested location. Accepts all values from http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
[props.locationReference]	Reference	Requested location
[props.note]	Annotation	Comments
[props.occurrence]	dateTime | Period | Timing	When service should occur
[props.orderDetail]	string	Additional order information. Accepts all values from http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
[props.patientInstruction]	string	Patient or consumer-oriented instructions
[props.performer]	Reference	Requested performer
[props.performerType]	string	Performer role. Accepts all values from http://terminology.hl7.org/ValueSet/action-participant-role
[props.priority]	string	routine
[props.quantity]	Quantity | Ratio | Range	Service amount
[props.reasonCode]	string	Explanation/Justification for procedure or service. Accepts all values from http://hl7.org/fhir/ValueSet/procedure-reason
[props.reasonReference]	Reference	Explanation/Justification for service or service
[props.relevantHistory]	Reference	Request provenance
[props.replaces]	Reference	What request replaces
[props.requester]	Reference	Who/what is requesting service
[props.requisition]	Identifier	Composite Request ID
[props.specimen]	Reference	Procedure Samples
[props.status]	string	draft
[props.subject]	Reference	Individual or Entity the service is ordered for
[props.supportingInfo]	Reference	Additional clinical information

---

builders.slot

slot(props)

Create a Slot resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.appointmentType]	string	The style of appointment or patient that may be booked in the slot (not service type). Accepts all values from http://terminology.hl7.org/ValueSet/v2-0276
[props.comment]	string	Comments on the slot to describe any extended information. Such as custom constraints on the slot
[props.end]	instant	Date/Time that the slot is to conclude
[props.identifier]	Identifier	External Ids for this item
[props.overbooked]	boolean	This slot has already been overbooked, appointments are unlikely to be accepted for this time
[props.schedule]	Reference	The schedule resource that this slot defines an interval of status information
[props.serviceCategory]	string	A broad categorization of the service that is to be performed during this appointment. Accepts all values from http://hl7.org/fhir/ValueSet/service-category
[props.serviceType]	string	The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource. Accepts all values from http://hl7.org/fhir/ValueSet/service-type
[props.specialty]	string	The specialty of a practitioner that would be required to perform the service requested in this appointment. Accepts all values from http://hl7.org/fhir/ValueSet/c80-practice-codes
[props.start]	instant	Date/Time that the slot is to begin
[props.status]	string	busy

---

builders.specimen

specimen(props)

Create a Specimen resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.accessionIdentifier]	Identifier	Identifier assigned by the lab
[props.collection]	BackboneElement	Collection details
[props.condition]	string	State of the specimen. Accepts all values from http://terminology.hl7.org/ValueSet/v2-0493
[props.container]	BackboneElement	Direct container of specimen (tube/slide, etc.)
[props.identifier]	Identifier	External Identifier
[props.note]	Annotation	Comments
[props.parent]	Reference	Specimen from which this specimen originated
[props.processing]	BackboneElement	Processing and processing step details
[props.receivedTime]	dateTime	The time when specimen was received for processing
[props.request]	Reference	Why the specimen was collected
[props.status]	string	available
[props.subject]	Reference	Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
[props.type]	string	Kind of material that forms the specimen. Accepts all values from http://terminology.hl7.org/ValueSet/v2-0487

---

builders.specimenDefinition

specimenDefinition(props)

Create a SpecimenDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.collection]	string	Specimen collection procedure. Accepts all values from http://hl7.org/fhir/ValueSet/specimen-collection
[props.identifier]	Identifier	Business identifier of a kind of specimen
[props.patientPreparation]	string	Patient preparation for collection. Accepts all values from http://hl7.org/fhir/ValueSet/prepare-patient-prior-specimen-collection
[props.timeAspect]	string	Time aspect for collection
[props.typeCollected]	string	Kind of material to collect. Accepts all values from http://terminology.hl7.org/ValueSet/v2-0487
[props.typeTested]	BackboneElement	Specimen in container intended for testing by lab

---

builders.substance

substance(props)

Create a Substance resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.category]	string	What class/type of substance this is. Accepts all values from http://hl7.org/fhir/ValueSet/substance-category
[props.code]	string	What substance this is. Accepts all values from http://hl7.org/fhir/ValueSet/substance-code
[props.description]	string	Textual description of the substance, comments
[props.identifier]	Identifier	Unique identifier
[props.ingredient]	BackboneElement	Composition information about the substance
[props.instance]	BackboneElement	If this describes a specific package/container of the substance
[props.status]	string	active

---

builders.substanceDefinition

substanceDefinition(props)

Create a SubstanceDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.classification]	CodeableConcept	A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity
[props.code]	BackboneElement	Codes associated with the substance
[props.description]	markdown	Textual description of the substance
[props.domain]	string	If the substance applies to human or veterinary use. Accepts all values from http://hl7.org/fhir/ValueSet/medicinal-product-domain
[props.grade]	string	The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP). Accepts all values from http://hl7.org/fhir/ValueSet/substance-grade
[props.identifier]	Identifier	Identifier by which this substance is known
[props.informationSource]	Reference	Supporting literature
[props.manufacturer]	Reference	The entity that creates, makes, produces or fabricates the substance
[props.moiety]	BackboneElement	Moiety, for structural modifications
[props.molecularWeight]	BackboneElement	The molecular weight or weight range
[props.name]	BackboneElement	Names applicable to this substance
[props.note]	Annotation	Textual comment about the substance's catalogue or registry record
[props.property]	BackboneElement	General specifications for this substance
[props.relationship]	BackboneElement	A link between this substance and another
[props.sourceMaterial]	BackboneElement	Material or taxonomic/anatomical source
[props.status]	string	Status of substance within the catalogue e.g. active, retired. Accepts all values from http://hl7.org/fhir/ValueSet/publication-status
[props.structure]	BackboneElement	Structural information
[props.supplier]	Reference	An entity that is the source for the substance. It may be different from the manufacturer
[props.version]	string	A business level version identifier of the substance

---

builders.supplyDelivery

supplyDelivery(props)

Create a SupplyDelivery resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.basedOn]	Reference	Fulfills plan, proposal or order
[props.destination]	Reference	Where the Supply was sent
[props.identifier]	Identifier	External identifier
[props.occurrence]	dateTime | Period | Timing	When event occurred
[props.partOf]	Reference	Part of referenced event
[props.patient]	Reference	Patient for whom the item is supplied
[props.receiver]	Reference	Who collected the Supply
[props.status]	string	in-progress
[props.suppliedItem]	BackboneElement	The item that is delivered or supplied
[props.supplier]	Reference	Dispenser
[props.type]	string	Category of dispense event. Accepts all values from http://hl7.org/fhir/ValueSet/supplydelivery-type

---

builders.supplyRequest

supplyRequest(props)

Create a SupplyRequest resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.authoredOn]	dateTime	When the request was made
[props.category]	string	The kind of supply (central, non-stock, etc.). Accepts all values from http://hl7.org/fhir/ValueSet/supplyrequest-kind
[props.deliverFrom]	Reference	The origin of the supply
[props.deliverTo]	Reference	The destination of the supply
[props.identifier]	Identifier	Business Identifier for SupplyRequest
[props.item]	string	Medication, Substance, or Device requested to be supplied. Accepts all values from http://hl7.org/fhir/ValueSet/supply-item
[props.occurrence]	dateTime | Period | Timing	When the request should be fulfilled
[props.parameter]	BackboneElement	Ordered item details
[props.priority]	string	routine
[props.quantity]	Quantity	The requested amount of the item indicated
[props.reasonCode]	string	The reason why the supply item was requested. Accepts all values from http://hl7.org/fhir/ValueSet/supplyrequest-reason
[props.reasonReference]	Reference	The reason why the supply item was requested
[props.requester]	Reference	Individual making the request
[props.status]	string	draft
[props.supplier]	Reference	Who is intended to fulfill the request

---

builders.task

task(props)

Create a Task resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.authoredOn]	dateTime	Task Creation Date
[props.basedOn]	Reference	Request fulfilled by this task
[props.businessStatus]	CodeableConcept	E.g. "Specimen collected", "IV prepped"
[props.code]	string	Task Type. Accepts all values from http://hl7.org/fhir/ValueSet/task-code
[props.description]	string	Human-readable explanation of task
[props.encounter]	Reference	Healthcare event during which this task originated
[props.executionPeriod]	Period	Start and end time of execution
[props.focus]	Reference	What task is acting on
[props.for]	Reference	Beneficiary of the Task
[props.groupIdentifier]	Identifier	Requisition or grouper id
[props.identifier]	Identifier	Task Instance Identifier
[props.input]	BackboneElement	Information used to perform task
[props.instantiatesCanonical]	canonical	Formal definition of task
[props.instantiatesUri]	string	Formal definition of task
[props.insurance]	Reference	Associated insurance coverage
[props.intent]	string	unknown
[props.lastModified]	dateTime	Task Last Modified Date
[props.location]	Reference	Where task occurs
[props.note]	Annotation	Comments made about the task
[props.output]	BackboneElement	Information produced as part of task
[props.owner]	Reference	Responsible individual
[props.partOf]	Reference	Composite task
[props.performerType]	string	Requested performer. Accepts all values from http://hl7.org/fhir/ValueSet/performer-role
[props.priority]	string	routine
[props.reasonCode]	CodeableConcept	Why task is needed
[props.reasonReference]	Reference	Why task is needed
[props.relevantHistory]	Reference	Key events in history of the Task
[props.requester]	Reference	Who is asking for task to be done
[props.restriction]	BackboneElement	Constraints on fulfillment tasks
[props.status]	string	draft
[props.statusReason]	CodeableConcept	Reason for current status

---

builders.testReport

testReport(props)

Create a TestReport resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.identifier]	Identifier	External identifier
[props.issued]	dateTime	When the TestScript was executed and this TestReport was generated
[props.name]	string	Informal name of the executed TestScript
[props.participant]	BackboneElement	A participant in the test execution, either the execution engine, a client, or a server
[props.result]	string	pass
[props.score]	decimal	The final score (percentage of tests passed) resulting from the execution of the TestScript
[props.setup]	BackboneElement	The results of the series of required setup operations before the tests were executed
[props.status]	string	completed
[props.teardown]	BackboneElement	The results of running the series of required clean up steps
[props.test]	BackboneElement	A test executed from the test script
[props.testScript]	Reference	Reference to the version-specific TestScript that was executed to produce this TestReport
[props.tester]	string	Name of the tester producing this report (Organization or individual)

---

builders.verificationResult

verificationResult(props)

Create a VerificationResult resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.attestation]	BackboneElement	Information about the entity attesting to information
[props.failureAction]	string	fatal
[props.frequency]	Timing	Frequency of revalidation
[props.lastPerformed]	dateTime	The date/time validation was last completed (including failed validations)
[props.need]	string	none
[props.nextScheduled]	date	The date when target is next validated, if appropriate
[props.primarySource]	BackboneElement	Information about the primary source(s) involved in validation
[props.status]	string	attested
[props.statusDate]	dateTime	When the validation status was updated
[props.target]	Reference	A resource that was validated
[props.targetLocation]	string	The fhirpath location(s) within the resource that was validated
[props.validationProcess]	string	The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context). Accepts all values from http://hl7.org/fhir/ValueSet/verificationresult-validation-process
[props.validationType]	string	nothing
[props.validator]	BackboneElement	Information about the entity validating information

---

builders.visionPrescription

visionPrescription(props)

Create a VisionPrescription resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.created]	dateTime	Response creation date
[props.dateWritten]	dateTime	When prescription was authorized
[props.encounter]	Reference	Created during encounter / admission / stay
[props.identifier]	Identifier	Business Identifier for vision prescription
[props.lensSpecification]	BackboneElement	Vision lens authorization
[props.patient]	Reference	Who prescription is for
[props.prescriber]	Reference	Who authorized the vision prescription
[props.status]	string	active

---

datatypes

These functions belong to the datatypes namespace.

datatypes.addExtension

addExtension(resource, url, value)

Add an extension to a resource (or object). An object will be created and added to an extension array on the provided resource. The extension array will be set if it does not exist on the resource. The value will be smartly written to the object, ie, valueDateTime or valueReference or valueString

Param	Type	Description
resource		a FHIR resource object to add an extension too
url	string	the URL to set for the extension
value		the value that the extension should contain

---

datatypes.cc

cc()

Alias for b.concept()

---

datatypes.coding

coding(code, system)

Create a coding object { code, system }. Systems will be mapped using the system map.

Param	Type	Description
code	string	the code value
system	string	URL to the system. Will be mapped using the system map.

---

datatypes.composite

composite(object, key, value)

Write a value to the target object using a typed key Ie, if key is value and the value is a date time string, this function will write valueDateTime to the object.

This function is poorly named.

Param	Type	Description
object		the object to write the composite key to
key	string	the base key to use to write the value
value		some value to write to the object

---

datatypes.concept

concept(value, extra)

Create a CodeableConcept. Codings can be coding objects or [code, system, extra] tuples (such as passed to b.coding()) Systems will be mapped with the system map

Param	Type	Description
value	string	the value
extra	object	Extra properties to write to the coding

Example: Create a codeableConcept

const myConcept = util.concept(['abc', 'http://moh.gov.et/fhir/hiv/identifier/SmartCareID'])

Example: Create a codeableConcept with text

const myConcept = util.concept('smart care id', ['abc', 'http://moh.gov.et/fhir/hiv/identifier/SmartCareID'])

---

datatypes.ext

ext()

Alias for b.extension()

---

datatypes.extension

extension(url, value, props)

Create an extension with a system and value Values will be typemapped (ie, value -> valueString) Optionally pass extra keys on the third argument

Param	Type	Description
url	string	the URL to set for the extension
value		the value that the extension should contain
props		extra props to add to the extension

---

datatypes.findExtension

findExtension(obj, targetUrl, [path])

Find an extension with a given url in some array

Param	Type	Description
obj		a fhir resource
targetUrl	string	the extension URL you want to find
[path]	string	a path to extract from the resource. Optional.

---

datatypes.id

id()

Alias for b.identifier()

---

datatypes.identifier

identifier(id, ext)

Create an Identifier. Systems will be mapped against the system map. Pass extensions as extra arguments.

Param	Description
id	A string identifier, a FHIR identifier object, or an array of either.
ext	Any other arguments will be treated as extensions

---

datatypes.ref

ref()

Alias for b.reference()

---

datatypes.reference

reference(ref)

Create a reference object of the form { reference } If ref is an array, each item will be mapped and an array returned. If ref is a FHIR resource, a reference to it will be generated If ref is a string, it'll be treated as a reference id and returned as an object If ref is a valid FHIR reference, it'll just be returned.

Param	Description
ref	the thing to generate a reference from

---

datatypes.setSystemMap

setSystemMap()

Define a set of mapped system values.

Builder functions will use this mappings when they encounter them in system keys. Useful for setting shortcuts.

Example: Set shortcut system mappings

b.setSystemMap({
  SmartCareID: 'http://moh.gov.et/fhir/hiv/identifier/SmartCareID'
});
create(builders.patient({ identifier: b.identifier('xyz', 'SmartCareId') }))

---

Interfaces

Address

Properties

Name	Type	Description
[city]	string	Name of city, town etc.
[country]	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
[district]	string	District name (aka county)
[extension]	Array.<Extension>	Additional content defined by implementations
[id]	string	Unique id for inter-element referencing
[line]	Array.<string>	Street name, number, direction & P.O. Box etc.
[period]	Period	Time period when address was/is in use
[postalCode]	string	Postal code for area
[state]	string	Sub-unit of country (abbreviations ok)
[text]	string	Text representation of the address
[type]	string	postal
[use]	string	home

---

CodeableConcept

Properties

Name	Type	Description
[coding]	Array.<Coding>	Code defined by a terminology system
[extension]	Array.<Extension>	Additional content defined by implementations
[id]	string	Unique id for inter-element referencing
[text]	string	Plain text representation of the concept

---

Coding

Properties

Name	Type	Description
[code]	string	Symbol in syntax defined by the system
[display]	string	Representation defined by the system
[extension]	Array.<Extension>	Additional content defined by implementations
[id]	string	Unique id for inter-element referencing
[system]	string	Identity of the terminology system
[userSelected]	boolean	If this coding was chosen directly by the user
[version]	string	Version of the system - if relevant

---

ContactPoint

Properties

Name	Type	Description
[extension]	Array.<Extension>	Additional content defined by implementations
[id]	string	Unique id for inter-element referencing
[period]	Period	Time period when the contact point was/is in use
[rank]	number	Specify preferred order of use (1 = highest)
[system]	string	phone
[use]	string	home
[value]	string	The actual contact point details

---

HumanName

Properties

Name	Type	Description
[extension]	Array.<Extension>	Additional content defined by implementations
[family]	string	Family name (often called 'Surname')
[given]	Array.<string>	Given names (not always 'first'). Includes middle names
[id]	string	Unique id for inter-element referencing
[period]	Period	Time period when name was/is in use
[prefix]	Array.<string>	Parts that come before the name
[suffix]	Array.<string>	Parts that come after the name
[text]	string	Text representation of the full name
[use]	string	usual

---

Identifier

Properties

Name	Type	Description
[assigner]	string | Reference	Organization that issued id (may be just text)
[extension]	Array.<Extension>	Additional content defined by implementations
[id]	string	Unique id for inter-element referencing
[period]	Period	Time period when id is/was valid for use
[system]	string	The namespace for the identifier value
[type]	Array.<string> | CodeableConcept	Description of identifier
[use]	string	usual
[value]	string	The value that is unique

---

Period

Properties

Name	Type	Description
[end]	string	End time with inclusive boundary, if not ongoing
[extension]	Array.<Extension>	Additional content defined by implementations
[id]	string	Unique id for inter-element referencing
[start]	string	Starting time with inclusive boundary

---

Reference

Properties

Name	Type	Description
[display]	string	Text alternative for the resource
[extension]	Array.<Extension>	Additional content defined by implementations
[id]	string	Unique id for inter-element referencing
[identifier]	string | Identifier	Logical reference, when literal reference is not known
[reference]	string	Literal reference, Relative, internal or absolute URL
[type]	string	Type the reference refers to (e.g. "Patient")

---