fhir-4@0.3.1

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.identifier]	Identifier	Account number
[props.status]	string	active
[props.type]	string	E.g. patient, expense, depreciation. Accepts all values from http://hl7.org/fhir/ValueSet/account-type
[props.name]	string	Human-readable label
[props.subject]	Reference	The entity that caused the expenses
[props.servicePeriod]	Period	Transaction window
[props.coverage]	BackboneElement	The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
[props.owner]	Reference	Entity managing the Account
[props.description]	string	Explanation of purpose/use
[props.guarantor]	BackboneElement	The parties ultimately responsible for balancing the Account
[props.partOf]	Reference	Reference to a parent Account

---

builders.activityDefinition

activityDefinition(props)

Create a ActivityDefinition resource.

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

---

builders.administrableProductDefinition

administrableProductDefinition(props)

Create a AdministrableProductDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.identifier]	Identifier	An identifier for the administrable product
[props.status]	string	draft
[props.formOf]	Reference	References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product
[props.administrableDoseForm]	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.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
[props.producedFrom]	Reference	Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
[props.ingredient]	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.device]	Reference	A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
[props.property]	BackboneElement	Characteristics e.g. a product's onset of action
[props.routeOfAdministration]	BackboneElement	The path by which the product is taken into or makes contact with the body

---

builders.adverseEvent

adverseEvent(props)

Create a AdverseEvent resource.

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

---

builders.allergyIntolerance

allergyIntolerance(props)

Create a AllergyIntolerance resource.

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

---

builders.appointment

appointment(props)

Create a Appointment resource.

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

---

builders.appointmentResponse

appointmentResponse(props)

Create a AppointmentResponse resource.

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

---

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.identifier]	Identifier	External ids for this item
[props.productCategory]	string	organ
[props.productCode]	CodeableConcept	What this biologically derived product is
[props.status]	string	available
[props.request]	Reference	Procedure request
[props.quantity]	integer	The amount of this biologically derived product
[props.parent]	Reference	BiologicallyDerivedProduct parent
[props.collection]	BackboneElement	How this product was collected
[props.processing]	BackboneElement	Any processing of the product during collection
[props.manipulation]	BackboneElement	Any manipulation of product post-collection
[props.storage]	BackboneElement	Product storage

---

builders.bodyStructure

bodyStructure(props)

Create a BodyStructure resource.

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

---

builders.careTeam

careTeam(props)

Create a CareTeam resource.

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

---

builders.chargeItem

chargeItem(props)

Create a ChargeItem resource.

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

---

builders.chargeItemDefinition

chargeItemDefinition(props)

Create a ChargeItemDefinition resource.

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

---

builders.citation

citation(props)

Create a Citation resource.

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

---

builders.claim

claim(props)

Create a Claim resource.

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

---

builders.claimResponse

claimResponse(props)

Create a ClaimResponse resource.

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

---

builders.clinicalImpression

clinicalImpression(props)

Create a ClinicalImpression resource.

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

---

builders.clinicalUseDefinition

clinicalUseDefinition(props)

Create a ClinicalUseDefinition resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.identifier]	Identifier	Business identifier for this issue
[props.type]	string	indication
[props.category]	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.subject]	Reference	The medication or procedure for which this is an indication
[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.contraindication]	BackboneElement	Specifics for when this is a contraindication
[props.indication]	BackboneElement	Specifics for when this is an indication
[props.interaction]	BackboneElement	Specifics for when this is an interaction
[props.population]	Reference	The population group to which this applies
[props.undesirableEffect]	BackboneElement	A possible negative outcome from the use of this treatment
[props.warning]	BackboneElement	Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'

---

builders.communication

communication(props)

Create a Communication resource.

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

---

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

---

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

---

builders.coverage

coverage(props)

Create a Coverage resource.

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

---

builders.coverageEligibilityRequest

coverageEligibilityRequest(props)

Create a CoverageEligibilityRequest resource.

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

---

builders.coverageEligibilityResponse

coverageEligibilityResponse(props)

Create a CoverageEligibilityResponse resource.

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

---

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

---

builders.device

device(props)

Create a Device resource.

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

---

builders.deviceDefinition

deviceDefinition(props)

Create a DeviceDefinition resource.

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

---

builders.deviceMetric

deviceMetric(props)

Create a DeviceMetric resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.identifier]	Identifier	Instance identifier
[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
[props.source]	Reference	Describes the link to the source Device
[props.parent]	Reference	Describes the link to the parent Device
[props.operationalStatus]	string	on
[props.color]	string	black
[props.category]	string	measurement
[props.measurementPeriod]	Timing	Describes the measurement repetition time
[props.calibration]	BackboneElement	Describes the calibrations that have been performed or that are required to be performed

---

builders.deviceRequest

deviceRequest(props)

Create a DeviceRequest resource.

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

---

builders.deviceUseStatement

deviceUseStatement(props)

Create a DeviceUseStatement resource.

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

---

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

---

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

---

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.identifier]	Identifier	Business Identifier
[props.status]	string	active
[props.created]	dateTime	Creation date
[props.insurer]	Reference	Target
[props.provider]	Reference	Responsible practitioner
[props.candidate]	Reference	The subject to be enrolled
[props.coverage]	Reference	Insurance information

---

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.identifier]	Identifier	Business Identifier
[props.status]	string	active
[props.request]	Reference	Claim reference
[props.outcome]	string	queued
[props.disposition]	string	Disposition Message
[props.created]	dateTime	Creation date
[props.organization]	Reference	Insurer
[props.requestProvider]	Reference	Responsible practitioner

---

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

---

builders.eventDefinition

eventDefinition(props)

Create a EventDefinition resource.

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

---

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

---

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

---

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

---

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

---

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.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.status]	string	partial
[props.dataAbsentReason]	string	subject-unknown
[props.patient]	Reference	Patient history is about
[props.date]	dateTime	When history was recorded or last updated
[props.name]	string	The family member described
[props.relationship]	string	Relationship to the subject. Accepts all values from http://terminology.hl7.org/ValueSet/v3-FamilyMember
[props.sex]	string	male
[props.born]	Period | date | string	(approximate) date of birth
[props.age]	Age | Range | string	(approximate) age
[props.estimatedAge]	boolean	Age is estimated?
[props.deceased]	boolean | Age | Range | date | string	Dead? How old/when?
[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.note]	Annotation	General note about related person
[props.condition]	BackboneElement	Condition that the related person had

---

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.identifier]	Identifier	Business identifier
[props.status]	string	active
[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.subject]	Reference	Who/What is flag about?
[props.period]	Period	Time period when flag is active
[props.encounter]	Reference	Alert relevant during encounter
[props.author]	Reference	Flag creator

---

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.identifier]	Identifier	External Ids for this goal
[props.lifecycleStatus]	string	proposed
[props.achievementStatus]	string	in-progress
[props.category]	string	E.g. Treatment, dietary, behavioral, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/goal-category
[props.priority]	string	high-priority
[props.description]	string	Code or text describing goal. Accepts all values from http://hl7.org/fhir/ValueSet/clinical-findings
[props.subject]	Reference	Who this goal is intended for
[props.start]	string	When goal pursuit begins. Accepts all values from http://hl7.org/fhir/ValueSet/goal-start-event
[props.target]	BackboneElement	Target outcome for the goal
[props.statusDate]	date	When goal status took effect
[props.statusReason]	string	Reason for current status
[props.expressedBy]	Reference	Who's responsible for creating Goal?
[props.addresses]	Reference	Issues addressed by this goal
[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

---

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.identifier]	Identifier	Unique id
[props.active]	boolean	Whether this group's record is in active use
[props.type]	string	person
[props.actual]	boolean	Descriptive or actual
[props.code]	CodeableConcept	Kind of Group members
[props.name]	string	Label for Group
[props.quantity]	unsignedInt	Number of members
[props.managingEntity]	Reference	Entity that is the custodian of the Group's definition
[props.characteristic]	BackboneElement	Include / Exclude group members by Trait
[props.member]	BackboneElement	Who or what is in group

---

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.requestIdentifier]	Identifier	The identifier of the request associated with this response, if any
[props.identifier]	Identifier	Business identifier
[props.module]	string | canonical | CodeableConcept	What guidance was requested
[props.status]	string	success
[props.subject]	Reference	Patient the request was performed for
[props.encounter]	Reference	Encounter during which the response was returned
[props.occurrenceDateTime]	dateTime	When the guidance response was processed
[props.performer]	Reference	Device returning the guidance
[props.reasonCode]	CodeableConcept	Why guidance is needed
[props.reasonReference]	Reference	Why guidance is needed
[props.note]	Annotation	Additional notes about the response
[props.evaluationMessage]	Reference	Messages resulting from the evaluation of the artifact or artifacts
[props.outputParameters]	Reference	The output parameters of the evaluation, if any
[props.result]	Reference	Proposed actions, if any
[props.dataRequirement]	DataRequirement	Additional required data

---

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

---

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.identifier]	Identifier	Identifiers for the whole study
[props.status]	string	registered
[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.subject]	Reference	Who or what is the subject of the study
[props.encounter]	Reference	Encounter with which this imaging study is associated
[props.started]	dateTime	When the study was started
[props.basedOn]	Reference	Request fulfilled
[props.referrer]	Reference	Referring physician
[props.interpreter]	Reference	Who interpreted images
[props.endpoint]	Reference	Study access endpoint
[props.numberOfSeries]	unsignedInt	Number of Study Related Series
[props.numberOfInstances]	unsignedInt	Number of Study Related Instances
[props.procedureReference]	Reference	The performed Procedure reference
[props.procedureCode]	string	The performed procedure code. Accepts all values from http://www.rsna.org/RadLex_Playbook.aspx
[props.location]	Reference	Where ImagingStudy occurred
[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.note]	Annotation	User-defined comments
[props.description]	string	Institution-generated description
[props.series]	BackboneElement	Each study has one or more series of instances

---

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

---

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.identifier]	Identifier	Business identifier
[props.status]	string	completed
[props.patient]	Reference	Who this evaluation is for
[props.date]	dateTime	Date evaluation was performed
[props.authority]	Reference	Who is responsible for publishing the recommendations
[props.targetDisease]	string	Evaluation target disease. Accepts all values from http://hl7.org/fhir/ValueSet/immunization-evaluation-target-disease
[props.immunizationEvent]	Reference	Immunization being evaluated
[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.description]	string	Evaluation notes
[props.series]	string	Name of vaccine series
[props.doseNumber]	number | string	Dose number within series
[props.seriesDoses]	number | string	Recommended number of doses for immunity

---

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.identifier]	Identifier	Business identifier
[props.patient]	Reference	Who this profile is for
[props.date]	dateTime	Date recommendation(s) created
[props.authority]	Reference	Who is responsible for protocol
[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.identifier]	Identifier	An identifier or code by which the ingredient can be referenced
[props.status]	string	draft
[props.for]	Reference	The product which this ingredient is a constituent part of
[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.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.allergenicIndicator]	boolean	If the ingredient is a known or suspected allergen
[props.manufacturer]	BackboneElement	An organization that manufactures this ingredient
[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.identifier]	Identifier	Business Identifier for Product
[props.status]	string	draft
[props.type]	string	Kind of product. Accepts all values from http://hl7.org/fhir/ValueSet/insuranceplan-type
[props.name]	string	Official name
[props.alias]	string	Alternate names
[props.period]	Period	When the product is available
[props.ownedBy]	Reference	Plan issuer
[props.administeredBy]	Reference	Product administrator
[props.coverageArea]	Reference	Where product applies
[props.contact]	BackboneElement	Contact for the product
[props.endpoint]	Reference	Technical endpoint
[props.network]	Reference	What networks are Included
[props.coverage]	BackboneElement	Coverage details
[props.plan]	BackboneElement	Plan details

---

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.identifier]	Identifier	Business Identifier for item
[props.status]	string	draft
[props.cancelledReason]	string	Reason for cancellation of this Invoice
[props.type]	CodeableConcept	Type of Invoice
[props.subject]	Reference	Recipient(s) of goods and services
[props.recipient]	Reference	Recipient of this invoice
[props.date]	dateTime	Invoice date / posting date
[props.participant]	BackboneElement	Participant in creation of this Invoice
[props.issuer]	Reference	Issuing Organization of Invoice
[props.account]	Reference	Account that is being balanced
[props.lineItem]	BackboneElement	Line items of this Invoice
[props.totalPriceComponent]	any	Components of Invoice total
[props.totalNet]	Money	Net total of this Invoice
[props.totalGross]	Money	Gross total of this Invoice
[props.paymentTerms]	markdown	Payment details
[props.note]	Annotation	Comments made about the 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.url]	string	Canonical identifier for this library, represented as a URI (globally unique)
[props.identifier]	Identifier	Additional identifier for the library
[props.version]	string	Business version of the library
[props.name]	string	Name for this library (computer friendly)
[props.title]	string	Name for this library (human friendly)
[props.subtitle]	string	Subordinate title of the library
[props.status]	string	draft
[props.experimental]	boolean	For testing purposes, not real usage
[props.type]	string	logic-library
[props.subject]	string	Type of individual the library content is focused on. Accepts all values from http://hl7.org/fhir/ValueSet/subject-type
[props.date]	dateTime	Date last changed
[props.publisher]	string	Name of the publisher (organization or individual)
[props.contact]	ContactDetail	Contact details for the publisher
[props.description]	markdown	Natural language description of the library
[props.useContext]	UsageContext	The context that the content is intended to support
[props.jurisdiction]	string	Intended jurisdiction for library (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.purpose]	markdown	Why this library is defined
[props.usage]	string	Describes the clinical usage of the library
[props.copyright]	markdown	Use and/or publishing restrictions
[props.approvalDate]	date	When the library was approved by publisher
[props.lastReviewDate]	date	When the library was last reviewed
[props.effectivePeriod]	Period	When the library is expected to be used
[props.topic]	string	E.g. Education, Treatment, Assessment, etc.. Accepts all values from http://hl7.org/fhir/ValueSet/definition-topic
[props.author]	ContactDetail	Who authored the content
[props.editor]	ContactDetail	Who edited the content
[props.reviewer]	ContactDetail	Who reviewed the content
[props.endorser]	ContactDetail	Who endorsed the content
[props.relatedArtifact]	RelatedArtifact	Additional documentation, citations, etc.
[props.parameter]	ParameterDefinition	Parameters defined by the library
[props.dataRequirement]	DataRequirement	What data is referenced by this library
[props.content]	Attachment	Contents of the library, either embedded or referenced

---

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

---

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

---

builders.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.status]	string	draft
[props.manufacturedDoseForm]	string	Dose form as manufactured (before any necessary transformation). Accepts all values from http://hl7.org/fhir/ValueSet/manufactured-dose-form
[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
[props.manufacturer]	Reference	Manufacturer of the item (Note that this should be named "manufacturer" but it currently causes technical issues)
[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.property]	BackboneElement	General characteristics of this item

---

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

---

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

---

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.identifier]	Identifier	Business identifier for this medication
[props.code]	string	Codes that identify this medication. Accepts all values from http://hl7.org/fhir/ValueSet/medication-codes
[props.status]	string	active
[props.manufacturer]	Reference	Manufacturer of the item
[props.form]	string	powder
[props.amount]	Ratio	Amount of drug in package
[props.ingredient]	BackboneElement	Active or inactive ingredient
[props.batch]	BackboneElement	Details about packaged medications

---

builders.medicationAdministration

medicationAdministration(props)

Create a MedicationAdministration resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.identifier]	Identifier	External identifier
[props.instantiates]	string	Instantiates protocol or definition
[props.partOf]	Reference	Part of referenced event
[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.category]	string	Type of medication usage. Accepts all values from http://hl7.org/fhir/ValueSet/medication-admin-category
[props.medication]	string	What was administered. Accepts all values from http://hl7.org/fhir/ValueSet/medication-codes
[props.subject]	Reference	Who received medication
[props.context]	Reference	Encounter or Episode of Care administered as part of
[props.supportingInformation]	Reference	Additional information to support administration
[props.effective]	dateTime | Period	Start and end time of administration
[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.device]	Reference	Device used to administer
[props.note]	Annotation	Information about the administration
[props.dosage]	BackboneElement	Details of how medication was taken
[props.eventHistory]	Reference	A list of events of interest in the lifecycle

---

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

---

builders.medicationKnowledge

medicationKnowledge(props)

Create a MedicationKnowledge resource.

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

---

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

---

builders.medicationStatement

medicationStatement(props)

Create a MedicationStatement resource.

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

---

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.identifier]	Identifier	Business identifier for this product. Could be an MPID
[props.type]	string	Regulatory type, e.g. Investigational or Authorized. Accepts all values from http://hl7.org/fhir/ValueSet/medicinal-product-type
[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.version]	string	A business identifier relating to a specific version of the product
[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.description]	markdown	General description of this product
[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.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.indication]	markdown	Description of indication(s) for this product, used when structured indications are not required
[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.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.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.pediatricUseIndicator]	string	If authorised for use in children. Accepts all values from http://hl7.org/fhir/ValueSet/medicinal-product-pediatric-use
[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.marketingStatus]	MarketingStatus	Marketing status of the medicinal product, in contrast to marketing authorization
[props.packagedMedicinalProduct]	string	Package type for the product. Accepts all values from http://hl7.org/fhir/ValueSet/medicinal-product-package-type
[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.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.attachedDocument]	Reference	Additional documentation about the medicinal product
[props.masterFile]	Reference	A master file for the medicinal product (e.g. Pharmacovigilance System Master File)
[props.contact]	BackboneElement	A product specific contact, person (in a role), or an organization
[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.name]	BackboneElement	The product's name, including full name and possibly coded parts
[props.crossReference]	BackboneElement	Reference to another product, e.g. for linking authorised to investigational product
[props.operation]	BackboneElement	A manufacturing or administrative process for the medicinal product
[props.characteristic]	BackboneElement	Key product features such as "sugar free", "modified release"

---

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.identifier]	Identifier	Unique ID for this particular sequence. This is a FHIR-defined id
[props.type]	string	aa
[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.patient]	Reference	Who and/or what this is about
[props.specimen]	Reference	Specimen used for sequencing
[props.device]	Reference	The method for sequencing
[props.performer]	Reference	Who should be responsible for test result
[props.quantity]	Quantity	The number of copies of the sequence of interest. (RNASeq)
[props.referenceSeq]	BackboneElement	A sequence used as reference
[props.variant]	BackboneElement	Variant in sequence
[props.observedSeq]	string	Sequence that was observed
[props.quality]	BackboneElement	An set of value as quality of sequence
[props.readCoverage]	integer	Average number of reads representing a given nucleotide in the reconstructed sequence
[props.repository]	BackboneElement	External repository which contains detailed report related with observedSeq in this resource
[props.pointer]	Reference	Pointer to next atomic sequence
[props.structureVariant]	BackboneElement	Structural variant

---

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.identifier]	Identifier	Identifiers assigned to this order
[props.instantiatesCanonical]	canonical	Instantiates FHIR protocol or definition
[props.instantiatesUri]	string	Instantiates external protocol or definition
[props.instantiates]	string	Instantiates protocol or definition
[props.status]	string	draft
[props.intent]	string	proposal
[props.patient]	Reference	The person who requires the diet, formula or nutritional supplement
[props.encounter]	Reference	The encounter associated with this nutrition order
[props.dateTime]	dateTime	Date and time the nutrition order was requested
[props.orderer]	Reference	Who ordered the diet, formula or nutritional supplement
[props.allergyIntolerance]	Reference	List of the patient's food and nutrition-related allergies and intolerances
[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.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.oralDiet]	BackboneElement	Oral diet components
[props.supplement]	BackboneElement	Supplement components
[props.enteralFormula]	BackboneElement	Enteral formula components
[props.note]	Annotation	Comments

---

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.status]	string	active
[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.manufacturer]	Reference	Manufacturer, representative or officially responsible for the product
[props.nutrient]	BackboneElement	The product's nutritional information expressed by the nutrients
[props.ingredient]	BackboneElement	Ingredients contained in this 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.productCharacteristic]	BackboneElement	Specifies descriptive properties of the nutrition product
[props.instance]	BackboneElement	One or several physical instances or occurrences of the nutrition product
[props.note]	Annotation	Comments made about the product

---

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

---

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.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.identifier]	Identifier	Business identifier for this ObservationDefinition instance
[props.permittedDataType]	string	Quantity
[props.multipleResultsAllowed]	boolean	Multiple results allowed
[props.method]	string	Method used to produce the observation. Accepts all values from http://hl7.org/fhir/ValueSet/observation-methods
[props.preferredReportName]	string	Preferred report name
[props.quantitativeDetails]	BackboneElement	Characteristics of quantitative results
[props.qualifiedInterval]	BackboneElement	Qualified range for continuous and ordinal observation results
[props.validCodedValueSet]	Reference	Value set of valid coded values for the observations conforming to this ObservationDefinition
[props.normalCodedValueSet]	Reference	Value set of normal coded values for the observations conforming to this ObservationDefinition
[props.abnormalCodedValueSet]	Reference	Value set of abnormal coded values for the observations conforming to this ObservationDefinition
[props.criticalCodedValueSet]	Reference	Value set of critical 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.identifier]	Identifier	Identifies this organization across multiple systems
[props.active]	boolean	Whether the organization's record is still in active use
[props.type]	string	Kind of organization. Accepts all values from http://hl7.org/fhir/ValueSet/organization-type
[props.name]	string	Name used 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.telecom]	ContactPoint	A contact detail for the organization
[props.address]	Address	An address for the organization
[props.partOf]	Reference	The organization of which this organization forms a part
[props.contact]	BackboneElement	Contact for the organization for a certain purpose
[props.endpoint]	Reference	Technical endpoints providing access to services operated for the organization

---

builders.organizationAffiliation

organizationAffiliation(props)

Create a OrganizationAffiliation resource.

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

---

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.identifier]	Identifier	A unique identifier for this package as whole
[props.name]	string	A name for this package. Typically as listed in a drug formulary, catalogue, inventory etc
[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
[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.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.description]	markdown	Textual description. Note that this is not the name of the package or product
[props.legalStatusOfSupply]	BackboneElement	The legal status of supply of the packaged item as classified by the regulator
[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.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.copackagedIndicator]	boolean	If the drug product is supplied with another item such as a diluent or adjuvant
[props.manufacturer]	Reference	Manufacturer of this package type (multiple means these are all possible manufacturers)
[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

---

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

---

builders.paymentNotice

paymentNotice(props)

Create a PaymentNotice resource.

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

---

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.identifier]	Identifier	Business Identifier for a payment reconciliation
[props.status]	string	active
[props.period]	Period	Period covered
[props.created]	dateTime	Creation date
[props.paymentIssuer]	Reference	Party generating payment
[props.request]	Reference	Reference to requesting resource
[props.requestor]	Reference	Responsible practitioner
[props.outcome]	string	queued
[props.disposition]	string	Disposition message
[props.paymentDate]	date	When payment issued
[props.paymentAmount]	Money	Total amount of Payment
[props.paymentIdentifier]	Identifier	Business identifier for the payment
[props.detail]	BackboneElement	Settlement particulars
[props.formCode]	string	Printed form identifier. Accepts all values from http://hl7.org/fhir/ValueSet/forms
[props.processNote]	BackboneElement	Note concerning processing

---

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.identifier]	Identifier	A human identifier for this person
[props.name]	HumanName	A name associated with the person
[props.telecom]	ContactPoint	A contact detail for the person
[props.gender]	string	male
[props.birthDate]	date	The date on which the person was born
[props.address]	Address	One or more addresses for the person
[props.photo]	Attachment	Image of the person
[props.managingOrganization]	Reference	The organization that is the custodian of the person record
[props.active]	boolean	This person's record is in active use
[props.link]	BackboneElement	Link to a resource that concerns the same actual 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.url]	string	Canonical identifier for this plan definition, represented as a URI (globally unique)
[props.identifier]	Identifier	Additional identifier for the plan definition
[props.version]	string	Business version of the plan definition
[props.name]	string	Name for this plan definition (computer friendly)
[props.title]	string	Name for this plan definition (human friendly)
[props.subtitle]	string	Subordinate title of the plan definition
[props.type]	string	order-set
[props.status]	string	draft
[props.experimental]	boolean	For testing purposes, not real usage
[props.subject]	string	Type of individual the plan definition is focused on. Accepts all values from http://hl7.org/fhir/ValueSet/subject-type
[props.date]	dateTime	Date last changed
[props.publisher]	string	Name of the publisher (organization or individual)
[props.contact]	ContactDetail	Contact details for the publisher
[props.description]	markdown	Natural language description of the plan definition
[props.useContext]	UsageContext	The context that the content is intended to support
[props.jurisdiction]	string	Intended jurisdiction for plan definition (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.purpose]	markdown	Why this plan definition is defined
[props.usage]	string	Describes the clinical usage of the plan
[props.copyright]	markdown	Use and/or publishing restrictions
[props.approvalDate]	date	When the plan definition was approved by publisher
[props.lastReviewDate]	date	When the plan definition was last reviewed
[props.effectivePeriod]	Period	When the plan definition is expected to be used
[props.topic]	string	E.g. Education, Treatment, Assessment. Accepts all values from http://hl7.org/fhir/ValueSet/definition-topic
[props.author]	ContactDetail	Who authored the content
[props.editor]	ContactDetail	Who edited the content
[props.reviewer]	ContactDetail	Who reviewed the content
[props.endorser]	ContactDetail	Who endorsed the content
[props.relatedArtifact]	RelatedArtifact	Additional documentation, citations
[props.library]	canonical	Logic used by the plan definition
[props.goal]	BackboneElement	What the plan is trying to accomplish
[props.action]	BackboneElement	Action defined by the plan

---

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

---

builders.practitionerRole

practitionerRole(props)

Create a PractitionerRole resource.

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

---

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

---

builders.questionnaire

questionnaire(props)

Create a Questionnaire resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.url]	string	Canonical identifier for this questionnaire, represented as a URI (globally unique)
[props.identifier]	Identifier	Additional identifier for the questionnaire
[props.version]	string	Business version of the questionnaire
[props.name]	string	Name for this questionnaire (computer friendly)
[props.title]	string	Name for this questionnaire (human friendly)
[props.derivedFrom]	canonical	Instantiates protocol or definition
[props.status]	string	draft
[props.experimental]	boolean	For testing purposes, not real usage
[props.subjectType]	string	Resource that can be subject of QuestionnaireResponse. Accepts all values from http://hl7.org/fhir/ValueSet/resource-types
[props.date]	dateTime	Date last changed
[props.publisher]	string	Name of the publisher (organization or individual)
[props.contact]	ContactDetail	Contact details for the publisher
[props.description]	markdown	Natural language description of the questionnaire
[props.useContext]	UsageContext	The context that the content is intended to support
[props.jurisdiction]	string	Intended jurisdiction for questionnaire (if applicable). Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[props.purpose]	markdown	Why this questionnaire is defined
[props.copyright]	markdown	Use and/or publishing restrictions
[props.approvalDate]	date	When the questionnaire was approved by publisher
[props.lastReviewDate]	date	When the questionnaire was last reviewed
[props.effectivePeriod]	Period	When the questionnaire is expected to be used
[props.code]	string	Concept that represents the overall questionnaire. Accepts all values from http://hl7.org/fhir/ValueSet/questionnaire-questions
[props.item]	BackboneElement	Questions and sections within 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.identifier]	Identifier	Unique id for this set of answers
[props.basedOn]	Reference	Request fulfilled by this QuestionnaireResponse
[props.partOf]	Reference	Part of this action
[props.questionnaire]	canonical	Form being answered
[props.status]	string	in-progress
[props.subject]	Reference	The subject of the questions
[props.encounter]	Reference	Encounter created as part of
[props.authored]	dateTime	Date the answers were gathered
[props.author]	Reference	Person who received and recorded the answers
[props.source]	Reference	The person who answered the questions
[props.item]	BackboneElement	Groups and 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.identifier]	Identifier	Business identifier for the authorization, typically assigned by the authorizing body
[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.description]	markdown	General textual supporting information
[props.region]	string	The territory in which the authorization has been granted. Accepts all values from http://hl7.org/fhir/ValueSet/jurisdiction
[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.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
[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.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.holder]	Reference	The organization that has been granted this authorization, by the regulator
[props.regulator]	Reference	The regulatory authority or authorizing body granting the authorization
[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)

---

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

---

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.identifier]	Identifier	Business identifier
[props.instantiatesCanonical]	canonical	Instantiates FHIR protocol or definition
[props.instantiatesUri]	string	Instantiates external protocol or definition
[props.basedOn]	Reference	Fulfills plan, proposal, or order
[props.replaces]	Reference	Request(s) replaced by this request
[props.groupIdentifier]	Identifier	Composite request this is part of
[props.status]	string	draft
[props.intent]	string	proposal
[props.priority]	string	routine
[props.code]	CodeableConcept	What's being requested/ordered
[props.subject]	Reference	Who the request group is about
[props.encounter]	Reference	Created as part of
[props.authoredOn]	dateTime	When the request group was authored
[props.author]	Reference	Device or practitioner that authored the request group
[props.reasonCode]	CodeableConcept	Why the request group is needed
[props.reasonReference]	Reference	Why the request group is needed
[props.note]	Annotation	Additional notes about the response
[props.action]	BackboneElement	Proposed actions, if any

---

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

---

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

---

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.identifier]	Identifier	Business Identifier for study
[props.title]	string	Name for this study
[props.protocol]	Reference	Steps followed in executing study
[props.partOf]	Reference	Part of larger study
[props.status]	string	active
[props.primaryPurposeType]	string	treatment
[props.phase]	string	n-a
[props.category]	CodeableConcept	Classifications for the study
[props.focus]	CodeableConcept	Drugs, devices, etc. under 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.relatedArtifact]	RelatedArtifact	References and dependencies
[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.description]	markdown	What this is study doing
[props.enrollment]	Reference	Inclusion & exclusion criteria
[props.period]	Period	When the study began and ended
[props.sponsor]	Reference	Organization that initiates and is legally responsible for the study
[props.principalInvestigator]	Reference	Researcher who oversees multiple aspects of the study
[props.site]	Reference	Facility where study activities are conducted
[props.reasonStopped]	string	accrual-goal-met
[props.note]	Annotation	Comments made about the study
[props.arm]	BackboneElement	Defined path through the study for a subject
[props.objective]	BackboneElement	A goal for the 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.identifier]	Identifier	Business Identifier for research subject in a study
[props.status]	string	candidate
[props.period]	Period	Start and end of participation
[props.study]	Reference	Study subject is part of
[props.individual]	Reference	Who is part of study
[props.assignedArm]	string	What path should be followed
[props.actualArm]	string	What path was followed
[props.consent]	Reference	Agreement to participate in study

---

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.identifier]	Identifier	Unique identifier for the assessment
[props.basedOn]	Reference	Request fulfilled by this assessment
[props.parent]	Reference	Part of this occurrence
[props.status]	string	registered
[props.method]	CodeableConcept	Evaluation mechanism
[props.code]	CodeableConcept	Type of assessment
[props.subject]	Reference	Who/what does assessment apply to?
[props.encounter]	Reference	Where was assessment performed?
[props.occurrence]	dateTime | Period	When was assessment made?
[props.condition]	Reference	Condition assessed
[props.performer]	Reference	Who did assessment?
[props.reasonCode]	CodeableConcept	Why the assessment was necessary?
[props.reasonReference]	Reference	Why the assessment was necessary?
[props.basis]	Reference	Information used in assessment
[props.prediction]	BackboneElement	Outcome predicted
[props.mitigation]	string	How to reduce risk
[props.note]	Annotation	Comments on the risk assessment

---

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.identifier]	Identifier	External Ids for this item
[props.active]	boolean	Whether this schedule is in active use
[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
[props.actor]	Reference	Resource(s) that availability information is being provided for
[props.planningHorizon]	Period	Period of time covered by schedule
[props.comment]	string	Comments on availability

---

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

---

builders.slot

slot(props)

Create a Slot resource.

Param	Type	Description
props	object	Properties to apply to the resource (includes common and custom properties).
[props.identifier]	Identifier	External Ids for this item
[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.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.schedule]	Reference	The schedule resource that this slot defines an interval of status information
[props.status]	string	busy
[props.start]	instant	Date/Time that the slot is to begin
[props.end]	instant	Date/Time that the slot is to conclude
[props.overbooked]	boolean	This slot has already been overbooked, appointments are unlikely to be accepted for this time
[props.comment]	string	Comments on the slot to describe any extended information. Such as custom constraints on the slot

---

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.identifier]	Identifier	External Identifier
[props.accessionIdentifier]	Identifier	Identifier assigned by the lab
[props.status]	string	available
[props.type]	string	Kind of material that forms the specimen. Accepts all values from http://terminology.hl7.org/ValueSet/v2-0487
[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.receivedTime]	dateTime	The time when specimen was received for processing
[props.parent]	Reference	Specimen from which this specimen originated
[props.request]	Reference	Why the specimen was collected
[props.collection]	BackboneElement	Collection details
[props.processing]	BackboneElement	Processing and processing step details
[props.container]	BackboneElement	Direct container of specimen (tube/slide, etc.)
[props.condition]	string	State of the specimen. Accepts all values from http://terminology.hl7.org/ValueSet/v2-0493
[props.note]	Annotation	Comments

---

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.identifier]	Identifier	Business identifier of a kind of specimen
[props.typeCollected]	string	Kind of material to collect. Accepts all values from http://terminology.hl7.org/ValueSet/v2-0487
[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.collection]	string	Specimen collection procedure. Accepts all values from http://hl7.org/fhir/ValueSet/specimen-collection
[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.identifier]	Identifier	Unique identifier
[props.status]	string	active
[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.instance]	BackboneElement	If this describes a specific package/container of the substance
[props.ingredient]	BackboneElement	Composition information about the substance

---

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.identifier]	Identifier	Identifier by which this substance is known
[props.version]	string	A business level version identifier of the substance
[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.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.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.description]	markdown	Textual description of the substance
[props.informationSource]	Reference	Supporting literature
[props.note]	Annotation	Textual comment about the substance's catalogue or registry record
[props.manufacturer]	Reference	The entity that creates, makes, produces or fabricates the substance
[props.supplier]	Reference	An entity that is the source for the substance. It may be different from the manufacturer
[props.moiety]	BackboneElement	Moiety, for structural modifications
[props.property]	BackboneElement	General specifications for this substance
[props.molecularWeight]	BackboneElement	The molecular weight or weight range
[props.structure]	BackboneElement	Structural information
[props.code]	BackboneElement	Codes associated with the substance
[props.name]	BackboneElement	Names applicable to this substance
[props.relationship]	BackboneElement	A link between this substance and another
[props.sourceMaterial]	BackboneElement	Material or taxonomic/anatomical source

---

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.identifier]	Identifier	External identifier
[props.basedOn]	Reference	Fulfills plan, proposal or order
[props.partOf]	Reference	Part of referenced event
[props.status]	string	in-progress
[props.patient]	Reference	Patient for whom the item is supplied
[props.type]	string	Category of dispense event. Accepts all values from http://hl7.org/fhir/ValueSet/supplydelivery-type
[props.suppliedItem]	BackboneElement	The item that is delivered or supplied
[props.occurrence]	dateTime | Period | Timing	When event occurred
[props.supplier]	Reference	Dispenser
[props.destination]	Reference	Where the Supply was sent
[props.receiver]	Reference	Who collected the Supply

---

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.identifier]	Identifier	Business Identifier for SupplyRequest
[props.status]	string	draft
[props.category]	string	The kind of supply (central, non-stock, etc.). Accepts all values from http://hl7.org/fhir/ValueSet/supplyrequest-kind
[props.priority]	string	routine
[props.item]	string	Medication, Substance, or Device requested to be supplied. Accepts all values from http://hl7.org/fhir/ValueSet/supply-item
[props.quantity]	Quantity	The requested amount of the item indicated
[props.parameter]	BackboneElement	Ordered item details
[props.occurrence]	dateTime | Period | Timing	When the request should be fulfilled
[props.authoredOn]	dateTime	When the request was made
[props.requester]	Reference	Individual making the request
[props.supplier]	Reference	Who is intended to fulfill the request
[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.deliverFrom]	Reference	The origin of the supply
[props.deliverTo]	Reference	The destination of the supply

---

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

---

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.name]	string	Informal name of the executed TestScript
[props.status]	string	completed
[props.testScript]	Reference	Reference to the version-specific TestScript that was executed to produce this TestReport
[props.result]	string	pass
[props.score]	decimal	The final score (percentage of tests passed) resulting from the execution of the TestScript
[props.tester]	string	Name of the tester producing this report (Organization or individual)
[props.issued]	dateTime	When the TestScript was executed and this TestReport was generated
[props.participant]	BackboneElement	A participant in the test execution, either the execution engine, a client, or a server
[props.setup]	BackboneElement	The results of the series of required setup operations before the tests were executed
[props.test]	BackboneElement	A test executed from the test script
[props.teardown]	BackboneElement	The results of running the series of required clean up steps

---

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.target]	Reference	A resource that was validated
[props.targetLocation]	string	The fhirpath location(s) within the resource that was validated
[props.need]	string	none
[props.status]	string	attested
[props.statusDate]	dateTime	When the validation status was updated
[props.validationType]	string	nothing
[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.frequency]	Timing	Frequency of revalidation
[props.lastPerformed]	dateTime	The date/time validation was last completed (including failed validations)
[props.nextScheduled]	date	The date when target is next validated, if appropriate
[props.failureAction]	string	fatal
[props.primarySource]	BackboneElement	Information about the primary source(s) involved in validation
[props.attestation]	BackboneElement	Information about the entity attesting to information
[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.identifier]	Identifier	Business Identifier for vision prescription
[props.status]	string	active
[props.created]	dateTime	Response creation date
[props.patient]	Reference	Who prescription is for
[props.encounter]	Reference	Created during encounter / admission / stay
[props.dateWritten]	dateTime	When prescription was authorized
[props.prescriber]	Reference	Who authorized the vision prescription
[props.lensSpecification]	BackboneElement	Vision lens authorization

---

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') }))

---