com.babylonhealth.lit.hl7.model

Type members

Classlikes

object Account extends CompanionFor[Account]
Companion:
class
@POJOBoilerplate
class Account(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val name: Option[String], val owner: Option[Reference], val status: ACCOUNT_STATUS, val partOf: Option[Reference], val subject: LitSeq[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val description: Option[String], val implicitRules: Option[UriStr], val servicePeriod: Option[Period], val modifierExtension: LitSeq[Extension], val coverage: LitSeq[Coverage], val guarantor: LitSeq[Guarantor], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.

A financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Categorizes the account for reporting and searching purposes.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
coverage
  • The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.
description
  • Provides additional information about what the account tracks and how it is used.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
guarantor
  • The parties responsible for balancing the account if other payment options fall short.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Unique identifier used to reference the account. Might or might not be intended for human use (e.g. credit card number).
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • Name used for the account when displaying it to humans in reports, etc.
owner
  • Indicates the service area, hospital, department, etc. with responsibility for managing the Account.
partOf
  • Reference to a parent Account.
servicePeriod
  • The date range of services associated with this account.
status
  • Indicates whether the account is presently used/usable or not.
subject
  • Identifies the entity which incurs the expenses. While the immediate recipients of services or goods might be entities related to the subject, the expenses were ultimately incurred by the subject of the Account.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, name, owner, status, partOf, subject, identifier, description, servicePeriod, coverage, guarantor.

Companion:
object
object ActivityDefinition extends CompanionFor[ActivityDefinition]
Companion:
class
@POJOBoilerplate
class ActivityDefinition(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], val kind: Option[REQUEST_RESOURCE_TYPES], val code: Option[CodeableConcept], val title: Option[String], val usage: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val intent: Option[REQUEST_INTENT], val dosage: LitSeq[Dosage], val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val library: LitSeq[Canonical], val profile: Option[Canonical], val language: Option[LANGUAGES], val subtitle: Option[String], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val priority: Option[REQUEST_PRIORITY], val location: Option[Reference], val quantity: Option[Quantity], val bodySite: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val timing: Option[TimingChoice], val transform: Option[Canonical], val identifier: LitSeq[Identifier], val subject: Option[SubjectChoice], val useContext: LitSeq[UsageContext], val product: Option[ProductChoice], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val doNotPerform: Option[Boolean], val implicitRules: Option[UriStr], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val modifierExtension: LitSeq[Extension], val specimenRequirement: LitSeq[Reference], val observationRequirement: LitSeq[Reference], val observationResultRequirement: LitSeq[Reference], val participant: LitSeq[Participant], val dynamicValue: LitSeq[DynamicValue], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
bodySite
  • Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
code
  • Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
date
  • The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.
description
  • A free text natural language description of the activity definition from a consumer's perspective.
doNotPerform
  • Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
dosage
  • Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
dynamicValue
  • Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectivePeriod
  • The period during which the activity definition content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
experimental
  • A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
intent
  • Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
jurisdiction
  • A legal or geographic region in which the activity definition is intended to be used.
kind
  • A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
library
  • A reference to a Library resource containing any formal logic used by the activity definition.
location
  • Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
observationRequirement
  • Defines observation requirements for the action to be performed, such as body weight or surface area.
observationResultRequirement
  • Defines the observations that are expected to be produced by the action.
participant
  • Indicates who should participate in performing the action described.
priority
  • Indicates how quickly the activity should be addressed with respect to other requests.
product
  • Identifies the food, drug or other product being consumed or supplied in the activity.
profile
  • A profile to which the target of the activity definition is expected to conform.
publisher
  • The name of the organization or individual that published the activity definition.
purpose
  • Explanation of why this activity definition is needed and why it has been designed as it has.
quantity
  • Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
relatedArtifact
  • Related artifacts such as additional documentation, justification, or bibliographic references.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
specimenRequirement
  • Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
status
  • The status of this activity definition. Enables tracking the life-cycle of the content.
subject
  • A code or group definition that describes the intended subject of the activity being defined.
subtitle
  • An explanatory or alternate title for the activity definition giving additional information about its content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
timing
  • The period, timing or frequency upon which the described activity is to occur.
title
  • A short, descriptive, user-friendly title for the activity definition.
topic
  • Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
transform
  • A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
url
  • An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
usage
  • A detailed description of how the activity definition is used from a clinical perspective.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.
version
  • The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
Constructor:

Introduces the fields url, name, date, kind, code, title, usage, topic, status, author, editor, intent, dosage, version, contact, purpose, library, profile, subtitle, reviewer, endorser, priority, location, quantity, bodySite, publisher, copyright, timing, transform, identifier, subject, useContext, product, description, experimental, jurisdiction, approvalDate, doNotPerform, lastReviewDate, effectivePeriod, relatedArtifact, specimenRequirement, observationRequirement, observationResultRequirement, participant, dynamicValue.

Companion:
object
object AdverseEvent extends CompanionFor[AdverseEvent]
Companion:
class
@POJOBoilerplate
class AdverseEvent(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val date: Option[FHIRDateTime], val event: Option[CodeableConcept], val study: LitSeq[Reference], val subject: Reference, val outcome: Option[CodeableConcept], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val detected: Option[FHIRDateTime], val location: Option[Reference], val severity: Option[CodeableConcept], val recorder: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val actuality: ADVERSE_EVENT_ACTUALITY, val encounter: Option[Reference], val identifier: Option[Identifier], val seriousness: Option[CodeableConcept], val contributor: LitSeq[Reference], val recordedDate: Option[FHIRDateTime], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val referenceDocument: LitSeq[Reference], val resultingCondition: LitSeq[Reference], val subjectMedicalHistory: LitSeq[Reference], val suspectEntity: LitSeq[SuspectEntity], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
actuality
  • Whether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely.
category
  • The overall type of event, intended for search and filtering purposes.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
contributor
  • Parties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness).
date
  • The date (and perhaps time) when the adverse event occurred.
detected
  • Estimated or actual date the AdverseEvent began, in the opinion of the reporter.
encounter
  • The Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.
event
  • This element defines the specific type of event that occurred or that was prevented from occurring.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
location
  • The information about where the adverse event occurred.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
outcome
  • Describes the type of outcome from the adverse event.
recordedDate
  • The date on which the existence of the AdverseEvent was first recorded.
recorder
  • Information on who recorded the adverse event. May be the patient or a practitioner.
referenceDocument
  • AdverseEvent.referenceDocument.
resultingCondition
  • Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
seriousness
  • Assessment whether this event was of real importance.
severity
  • Describes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is.
study
  • AdverseEvent.study.
subject
  • This subject or group impacted by the event.
subjectMedicalHistory
  • AdverseEvent.subjectMedicalHistory.
suspectEntity
  • Describes the entity that is suspected to have caused the adverse event.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields date, event, study, subject, outcome, category, detected, location, severity, recorder, actuality, encounter, identifier, seriousness, contributor, recordedDate, referenceDocument, resultingCondition, subjectMedicalHistory, suspectEntity.

Companion:
object
object AllergyIntolerance extends CompanionFor[AllergyIntolerance]
Companion:
class
@POJOBoilerplate
class AllergyIntolerance(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[ALLERGY_INTOLERANCE_TYPE], val code: Option[CodeableConcept], val note: LitSeq[Annotation], val patient: Reference, val language: Option[LANGUAGES], val category: LitSeq[ALLERGY_INTOLERANCE_CATEGORY], val onset: Option[OnsetChoice], val recorder: Option[Reference], val asserter: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val criticality: Option[ALLERGY_INTOLERANCE_CRITICALITY], val recordedDate: Option[FHIRDateTime], val implicitRules: Option[UriStr], val clinicalStatus: Option[CodeableConcept], val lastOccurrence: Option[FHIRDateTime], val modifierExtension: LitSeq[Extension], val verificationStatus: Option[CodeableConcept], val reaction: LitSeq[Reaction], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Identification of the underlying physiological mechanism for the reaction risk.
asserter
  • The source of the information about the allergy that is recorded.
category
  • Category of the identified substance.
clinicalStatus
  • The clinical status of the allergy or intolerance.
code
  • Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
criticality
  • Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
encounter
  • The encounter when the allergy or intolerance was asserted.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
lastOccurrence
  • Represents the date and/or time of the last known occurrence of a reaction event.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
onset
  • Estimated or actual date, date-time, or age when allergy or intolerance was identified.
patient
  • The patient who has the allergy or intolerance.
reaction
  • Details about each adverse reaction event linked to exposure to the identified substance.
recordedDate
  • The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
recorder
  • Individual who recorded the record and takes responsibility for its content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
verificationStatus
  • Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
Constructor:

Introduces the fields type, code, note, patient, category, onset, recorder, asserter, encounter, identifier, criticality, recordedDate, clinicalStatus, lastOccurrence, verificationStatus, reaction.

Companion:
object
object Appointment extends CompanionFor[Appointment]
Companion:
class
@POJOBoilerplate
class Appointment(val id: Option[String], val end: Option[ZonedDateTime], val meta: Option[Meta], val text: Option[Narrative], val slot: LitSeq[Reference], val start: Option[ZonedDateTime], val status: APPOINTMENTSTATUS, val created: Option[FHIRDateTime], val comment: Option[String], val basedOn: LitSeq[Reference], val language: Option[LANGUAGES], val priority: Option[UnsignedInt], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val specialty: LitSeq[CodeableConcept], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val serviceType: LitSeq[CodeableConcept], val description: Option[String], val implicitRules: Option[UriStr], val serviceCategory: LitSeq[CodeableConcept], val appointmentType: Option[CodeableConcept], val reasonReference: LitSeq[Reference], val minutesDuration: Option[PositiveInt], val requestedPeriod: LitSeq[Period], val modifierExtension: LitSeq[Extension], val cancelationReason: Option[CodeableConcept], val patientInstruction: Option[String], val supportingInformation: LitSeq[Reference], val participant: NonEmptyLitSeq[Participant], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
appointmentType
  • The style of appointment or patient that has been booked in the slot (not service type).
basedOn
  • The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
cancelationReason
  • The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
comment
  • Additional comments about the appointment.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
created
  • The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
description
  • The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
end
  • Date/Time that the appointment is to conclude.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
minutesDuration
  • Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
participant
  • List of participants involved in the appointment.
patientInstruction
  • While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
priority
  • The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
reasonCode
  • The coded reason that this appointment is being scheduled. This is more clinical than administrative.
reasonReference
  • Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
requestedPeriod
  • A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.
serviceCategory
  • A broad categorization of the service that is to be performed during this appointment.
serviceType
  • The specific service that is to be performed during this appointment.
slot
  • The slots from the participants' schedules that will be filled by the appointment.
specialty
  • The specialty of a practitioner that would be required to perform the service requested in this appointment.
start
  • Date/Time that the appointment is to take place.
status
  • The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
supportingInformation
  • Additional information to support the appointment provided when making the appointment.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields end, slot, start, status, created, comment, basedOn, priority, specialty, identifier, reasonCode, serviceType, description, serviceCategory, appointmentType, reasonReference, minutesDuration, requestedPeriod, cancelationReason, patientInstruction, supportingInformation, participant.

Companion:
object
object AppointmentResponse extends CompanionFor[AppointmentResponse]
Companion:
class
@POJOBoilerplate
class AppointmentResponse(val id: Option[String], val end: Option[ZonedDateTime], val meta: Option[Meta], val text: Option[Narrative], val start: Option[ZonedDateTime], val actor: Option[Reference], val comment: Option[String], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val appointment: Reference, val implicitRules: Option[UriStr], val participantType: LitSeq[CodeableConcept], val modifierExtension: LitSeq[Extension], val participantStatus: PARTICIPATIONSTATUS, val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
actor
  • A Person, Location, HealthcareService, or Device that is participating in the appointment.
appointment
  • Appointment that this response is replying to.
comment
  • Additional comments about the appointment.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
end
  • This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
participantStatus
  • Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
participantType
  • Role of participant in the appointment.
start
  • Date/Time that the appointment is to take place, or requested new start time.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields end, start, actor, comment, identifier, appointment, participantType, participantStatus.

Companion:
object
object AuditEvent extends CompanionFor[AuditEvent]
Companion:
class
@POJOBoilerplate
class AuditEvent(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Coding, val action: Option[AUDIT_EVENT_ACTION], val period: Option[Period], val subtype: LitSeq[Coding], val outcome: Option[AUDIT_EVENT_OUTCOME], val language: Option[LANGUAGES], val recorded: ZonedDateTime, val contained: LitSeq[Resource], val extension: LitSeq[Extension], val outcomeDesc: Option[String], val implicitRules: Option[UriStr], val purposeOfEvent: LitSeq[CodeableConcept], val modifierExtension: LitSeq[Extension], val source: Source, val agent: NonEmptyLitSeq[Agent], val entity: LitSeq[Entity], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.
action
  • Indicator for type of action performed during the event that generated the audit.
agent
  • An actor taking an active role in the event or activity that is logged.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
entity
  • Specific instances of data or objects that have been accessed.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
outcome
  • Indicates whether the event succeeded or failed.
outcomeDesc
  • A free text description of the outcome of the event.
period
  • The period during which the activity occurred.
purposeOfEvent
  • The purposeOfUse (reason) that was used during the event being recorded.
recorded
  • The time when the event was recorded.
source
  • The system that is reporting the event.
subtype
  • Identifier for the category of event.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, action, period, subtype, outcome, recorded, outcomeDesc, purposeOfEvent, source, agent, entity.

Companion:
object
object Basic extends CompanionFor[Basic]
Companion:
class
@POJOBoilerplate
class Basic(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: CodeableConcept, val author: Option[Reference], val subject: Option[Reference], val created: Option[FHIRDate], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
author
  • Indicates who was responsible for creating the resource instance.
code
  • Identifies the 'type' of resource - equivalent to the resource name for other resources.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
created
  • Identifies when the resource was first created.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifier assigned to the resource for business purposes, outside the context of FHIR.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
subject
  • Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, author, subject, created, identifier.

Companion:
object
object Binary extends CompanionFor[Binary]
Companion:
class
@POJOBoilerplate
class Binary(val id: Option[String], val meta: Option[Meta], val data: Option[Base64Binary], val language: Option[LANGUAGES], val contentType: Code, val implicitRules: Option[UriStr], val securityContext: Option[Reference], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Resource

A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.

A resource that represents the data of a single raw artifact as digital content accessible in its native format. A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.

Subclass of core.model.Resource (This is the base resource type for everything.)

Value parameters:
contentType
  • MimeType of the binary content represented as a standard MimeType (BCP 13).
data
  • The actual content, base64 encoded.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
securityContext
  • This element identifies another resource that can be used as a proxy of the security sensitivity to use when deciding and enforcing access control rules for the Binary resource. Given that the Binary resource contains very few elements that can be used to determine the sensitivity of the data and relationships to individuals, the referenced resource stands in as a proxy equivalent for this purpose. This referenced resource may be related to the Binary (e.g. Media, DocumentReference), or may be some non-related Resource purely as a security proxy. E.g. to identify that the binary resource relates to a patient, and access should only be granted to applications that have access to the patient.
Constructor:

Introduces the fields data, contentType, securityContext.

Companion:
object
Companion:
class
@POJOBoilerplate
class BiologicallyDerivedProduct(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val status: Option[PRODUCT_STATUS], val parent: LitSeq[Reference], val request: LitSeq[Reference], val language: Option[LANGUAGES], val quantity: Option[Int], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val productCode: Option[CodeableConcept], val implicitRules: Option[UriStr], val productCategory: Option[PRODUCT_CATEGORY], val modifierExtension: LitSeq[Extension], val storage: LitSeq[Storage], val collection: Option[Collection], val processing: LitSeq[Processing], val manipulation: Option[Manipulation], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.

A material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
collection
  • How this product was collected.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • This records identifiers associated with this biologically derived product instance that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
manipulation
  • Any manipulation of product post-collection that is intended to alter the product. For example a buffy-coat enrichment or CD8 reduction of Peripheral Blood Stem Cells to make it more suitable for infusion.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
parent
  • Parent product (if any).
processing
  • Any processing of the product during collection that does not change the fundamental nature of the product. For example adding anti-coagulants during the collection of Peripheral Blood Stem Cells.
productCategory
  • Broad category of this product.
productCode
  • A code that identifies the kind of this biologically derived product (SNOMED Ctcode).
quantity
  • Number of discrete units within this product.
request
  • Procedure request to obtain this biologically derived product.
status
  • Whether the product is currently available.
storage
  • Product storage.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields status, parent, request, quantity, identifier, productCode, productCategory, storage, collection, processing, manipulation.

Companion:
object
object BodyStructure extends CompanionFor[BodyStructure]
Companion:
class
@POJOBoilerplate
class BodyStructure(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val image: LitSeq[Attachment], val active: Option[Boolean], val patient: Reference, val language: Option[LANGUAGES], val location: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val morphology: Option[CodeableConcept], val description: Option[String], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val locationQualifier: LitSeq[CodeableConcept], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
active
  • Whether this body site is in active use.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
description
  • A summary, characterization or explanation of the body structure.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifier for this instance of the anatomical structure.
image
  • Image or images used to identify a location.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
location
  • The anatomical location or region of the specimen, lesion, or body structure.
locationQualifier
  • Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
morphology
  • The kind of structure being represented by the body structure at BodyStructure.location. This can define both normal and abnormal morphologies.
patient
  • The person to which the body site belongs.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields image, active, patient, location, identifier, morphology, description, locationQualifier.

Companion:
object
object Bundle extends CompanionFor[Bundle]
Companion:
class
@POJOBoilerplate
class Bundle(val id: Option[String], val meta: Option[Meta], `type`: BUNDLE_TYPE, val total: Option[UnsignedInt], val language: Option[LANGUAGES], val timestamp: Option[ZonedDateTime], val signature: Option[Signature], val identifier: Option[Identifier], val implicitRules: Option[UriStr], val link: LitSeq[Link], val entry: LitSeq[Entry], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Resource

A container for a collection of resources.

A container for a collection of resources.

Subclass of core.model.Resource (This is the base resource type for everything.)

Value parameters:
`type`
  • Indicates the purpose of this bundle - how it is intended to be used.
entry
  • An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A persistent identifier for the bundle that won't change as a bundle is copied from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
link
  • A series of links that provide context to this bundle.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
signature
  • Digital Signature - base64 encoded. XML-DSig or a JWT.
timestamp
  • The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
total
  • If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.
Constructor:

Introduces the fields type, total, timestamp, signature, identifier, link, entry.

Companion:
object
object CapabilityStatement extends CompanionFor[CapabilityStatement]
Companion:
class
@POJOBoilerplate
class CapabilityStatement(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: FHIRDateTime, val kind: CAPABILITY_STATEMENT_KIND, val title: Option[String], val status: PUBLICATION_STATUS, val format: NonEmptyLitSeq[Code], val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val imports: LitSeq[Canonical], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val fhirVersion: FHIR_VERSION, val patchFormat: LitSeq[Code], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val instantiates: LitSeq[Canonical], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val implementationGuide: LitSeq[Canonical], val software: Option[Software], val document: LitSeq[Document], val implementation: Option[Implementation], val rest: LitSeq[Rest], val messaging: LitSeq[Messaging], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
date
  • The date (and optionally time) when the capability statement was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.
description
  • A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
document
  • A document definition.
experimental
  • A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
fhirVersion
  • The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.
format
  • A list of the formats supported by this implementation using their content types.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implementation
  • Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
implementationGuide
  • A list of implementation guides that the server does (or should) support in their entirety.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
imports
  • Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.
instantiates
  • Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.
jurisdiction
  • A legal or geographic region in which the capability statement is intended to be used.
kind
  • The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).
language
  • The base language in which the resource is written.
messaging
  • A description of the messaging capabilities of the solution.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
patchFormat
  • A list of the patch formats supported by this implementation using their content types.
publisher
  • The name of the organization or individual that published the capability statement.
purpose
  • Explanation of why this capability statement is needed and why it has been designed as it has.
rest
  • A definition of the restful capabilities of the solution, if any.
software
  • Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
status
  • The status of this capability statement. Enables tracking the life-cycle of the content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the capability statement.
url
  • An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances.
version
  • The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, kind, title, status, format, version, contact, purpose, imports, publisher, copyright, useContext, description, fhirVersion, patchFormat, experimental, jurisdiction, instantiates, implementationGuide, software, document, implementation, rest, messaging.

Companion:
object
object CarePlan extends CompanionFor[CarePlan]
Companion:
class
@POJOBoilerplate
class CarePlan(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val goal: LitSeq[Reference], val note: LitSeq[Annotation], val title: Option[String], val partOf: LitSeq[Reference], val status: REQUEST_STATUS, val intent: CARE_PLAN_INTENT, val period: Option[Period], val author: Option[Reference], val basedOn: LitSeq[Reference], val subject: Reference, val created: Option[FHIRDateTime], val language: Option[LANGUAGES], val replaces: LitSeq[Reference], val category: LitSeq[CodeableConcept], val careTeam: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val addresses: LitSeq[Reference], val identifier: LitSeq[Identifier], val description: Option[String], val contributor: LitSeq[Reference], val implicitRules: Option[UriStr], val supportingInfo: LitSeq[Reference], val instantiatesUri: LitSeq[UriStr], val modifierExtension: LitSeq[Extension], val instantiatesCanonical: LitSeq[Canonical], val activity: LitSeq[Activity], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
activity
  • Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
addresses
  • Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
author
  • When populated, the author is responsible for the care plan. The care plan is attributed to the author.
basedOn
  • A care plan that is fulfilled in whole or in part by this care plan.
careTeam
  • Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
category
  • Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
contributor
  • Identifies the individual(s) or organization who provided the contents of the care plan.
created
  • Represents when this particular CarePlan record was created in the system, which is often a system-generated date.
description
  • A description of the scope and nature of the plan.
encounter
  • The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
goal
  • Describes the intended objective(s) of carrying out the care plan.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
instantiatesCanonical
  • The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
instantiatesUri
  • The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
intent
  • Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • General notes about the care plan not covered elsewhere.
partOf
  • A larger care plan of which this particular care plan is a component or step.
period
  • Indicates when the plan did (or is intended to) come into effect and end.
replaces
  • Completed or terminated care plan whose function is taken by this new care plan.
status
  • Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
subject
  • Identifies the patient or group whose intended care is described by the plan.
supportingInfo
  • Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • Human-friendly name for the care plan.
Constructor:

Introduces the fields goal, note, title, partOf, status, intent, period, author, basedOn, subject, created, replaces, category, careTeam, encounter, addresses, identifier, description, contributor, supportingInfo, instantiatesUri, instantiatesCanonical, activity.

Companion:
object
object CareTeam extends CompanionFor[CareTeam]
Companion:
class
@POJOBoilerplate
class CareTeam(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val note: LitSeq[Annotation], val status: Option[CARE_TEAM_STATUS], val period: Option[Period], val subject: Option[Reference], val telecom: LitSeq[ContactPoint], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val reasonReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val managingOrganization: LitSeq[Reference], val participant: LitSeq[Participant], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
category
  • Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
encounter
  • The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
managingOrganization
  • The organization responsible for the care team.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.
note
  • Comments made about the CareTeam.
participant
  • Identifies all people and organizations who are expected to be involved in the care team.
period
  • Indicates when the team did (or is intended to) come into effect and end.
reasonCode
  • Describes why the care team exists.
reasonReference
  • Condition(s) that this care team addresses.
status
  • Indicates the current state of the care team.
subject
  • Identifies the patient or group whose intended care is handled by the team.
telecom
  • A central contact detail for the care team (that applies to all members).
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields name, note, status, period, subject, telecom, category, encounter, identifier, reasonCode, reasonReference, managingOrganization, participant.

Companion:
object
object CatalogEntry extends CompanionFor[CatalogEntry]
Companion:
class
@POJOBoilerplate
class CatalogEntry(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val status: Option[PUBLICATION_STATUS], val validTo: Option[FHIRDateTime], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val orderable: Boolean, val identifier: LitSeq[Identifier], val lastUpdated: Option[FHIRDateTime], val implicitRules: Option[UriStr], val referencedItem: Reference, val classification: LitSeq[CodeableConcept], val validityPeriod: Option[Period], val modifierExtension: LitSeq[Extension], val additionalIdentifier: LitSeq[Identifier], val additionalCharacteristic: LitSeq[CodeableConcept], val additionalClassification: LitSeq[CodeableConcept], val relatedEntry: LitSeq[RelatedEntry], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Catalog entries are wrappers that contextualize items included in a catalog.

Catalog entries are wrappers that contextualize items included in a catalog.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The type of item - medication, device, service, protocol or other.
additionalCharacteristic
  • Used for examplefor Out of Formulary, or any specifics.
additionalClassification
  • User for example for ATC classification, or.
additionalIdentifier
  • Used in supporting related concepts, e.g. NDC to RxNorm.
classification
  • Classes of devices, or ATC for medication.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
lastUpdated
  • Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
orderable
  • Whether the entry represents an orderable item.
referencedItem
  • The item in a catalog or definition.
relatedEntry
  • Used for example, to point to a substance, or to a device used to administer a medication.
status
  • Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
validTo
  • The date until which this catalog entry is expected to be active.
validityPeriod
  • The time period in which this catalog entry is expected to be active.
Constructor:

Introduces the fields type, status, validTo, orderable, identifier, lastUpdated, referencedItem, classification, validityPeriod, additionalIdentifier, additionalCharacteristic, additionalClassification, relatedEntry.

Companion:
object
object ChargeItem extends CompanionFor[ChargeItem]
Companion:
class
@POJOBoilerplate
class ChargeItem(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: CodeableConcept, val note: LitSeq[Annotation], val status: CHARGEITEM_STATUS, val partOf: LitSeq[Reference], val reason: LitSeq[CodeableConcept], val subject: Reference, val context: Option[Reference], val enterer: Option[Reference], val service: LitSeq[Reference], val account: LitSeq[Reference], val language: Option[LANGUAGES], val quantity: Option[Quantity], val bodysite: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val costCenter: Option[Reference], val product: Option[ProductChoice], val enteredDate: Option[FHIRDateTime], val implicitRules: Option[UriStr], val definitionUri: LitSeq[UriStr], val occurrence: Option[OccurrenceChoice], val priceOverride: Option[Money], val factorOverride: Option[BigDecimal], val overrideReason: Option[String], val modifierExtension: LitSeq[Extension], val definitionCanonical: LitSeq[Canonical], val supportingInformation: LitSeq[Reference], val performingOrganization: Option[Reference], val requestingOrganization: Option[Reference], val performer: LitSeq[Performer], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.

The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
account
  • Account into which this ChargeItems belongs.
bodysite
  • The anatomical location where the related service has been applied.
code
  • A code that identifies the charge, like a billing code.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
context
  • The encounter or episode of care that establishes the context for this event.
costCenter
  • The financial cost center permits the tracking of charge attribution.
definitionCanonical
  • References the source of pricing information, rules of application for the code this ChargeItem uses.
definitionUri
  • References the (external) source of pricing information, rules of application for the code this ChargeItem uses.
enteredDate
  • Date the charge item was entered.
enterer
  • The device, practitioner, etc. who entered the charge item.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
factorOverride
  • Factor overriding the factor determined by the rules associated with the code.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers assigned to this event performer or other systems.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Comments made about the event by the performer, subject or other participants.
occurrence
  • Date/time(s) or duration when the charged service was applied.
overrideReason
  • If the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.
partOf
  • ChargeItems can be grouped to larger ChargeItems covering the whole set.
performer
  • Indicates who or what performed or participated in the charged service.
performingOrganization
  • The organization requesting the service.
priceOverride
  • Total price of the charge overriding the list price associated with the code.
product
  • Identifies the device, food, drug or other product being charged either by type code or reference to an instance.
quantity
  • Quantity of which the charge item has been serviced.
reason
  • Describes why the event occurred in coded or textual form.
requestingOrganization
  • The organization performing the service.
service
  • Indicated the rendered service that caused this charge.
status
  • The current state of the ChargeItem.
subject
  • The individual or set of individuals the action is being or was performed on.
supportingInformation
  • Further information supporting this charge.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, note, status, partOf, reason, subject, context, enterer, service, account, quantity, bodysite, identifier, costCenter, product, enteredDate, definitionUri, occurrence, priceOverride, factorOverride, overrideReason, definitionCanonical, supportingInformation, performingOrganization, requestingOrganization, performer.

Companion:
object
object ChargeItemDefinition extends CompanionFor[ChargeItemDefinition]
Companion:
class
@POJOBoilerplate
class ChargeItemDefinition(val id: Option[String], val url: UriStr, val meta: Option[Meta], val text: Option[Narrative], val date: Option[FHIRDateTime], val code: Option[CodeableConcept], val title: Option[String], val partOf: LitSeq[Canonical], val status: PUBLICATION_STATUS, val version: Option[String], val contact: LitSeq[ContactDetail], val language: Option[LANGUAGES], val replaces: LitSeq[Canonical], val instance: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val derivedFromUri: LitSeq[UriStr], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val modifierExtension: LitSeq[Extension], val applicability: LitSeq[Applicability], val propertyGroup: LitSeq[PropertyGroup], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.

The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
applicability
  • Expressions that describe applicability criteria for the billing code.
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
code
  • The defined billing details in this resource pertain to the given billing code.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.
date
  • The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.
derivedFromUri
  • The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.
description
  • A free text natural language description of the charge item definition from a consumer's perspective.
effectivePeriod
  • The period during which the charge item definition content was or is planned to be in active use.
experimental
  • A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
instance
  • The defined billing details in this resource pertain to the given product instance(s).
jurisdiction
  • A legal or geographic region in which the charge item definition is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
partOf
  • A larger definition of which this particular definition is a component or step.
propertyGroup
  • Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.
publisher
  • The name of the organization or individual that published the charge item definition.
replaces
  • As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.
status
  • The current state of the ChargeItemDefinition.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the charge item definition.
url
  • An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.
version
  • The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
Constructor:

Introduces the fields url, date, code, title, partOf, status, version, contact, replaces, instance, publisher, copyright, identifier, useContext, description, experimental, jurisdiction, approvalDate, derivedFromUri, lastReviewDate, effectivePeriod, applicability, propertyGroup.

Companion:
object
object Claim extends CompanionFor[Claim]
Companion:
class
@POJOBoilerplate
class Claim(val id: Option[String], val use: CLAIM_USE, val meta: Option[Meta], val text: Option[Narrative], `type`: CodeableConcept, val total: Option[Money], val status: FM_STATUS, val subType: Option[CodeableConcept], val patient: Reference, val created: FHIRDateTime, val enterer: Option[Reference], val insurer: Option[Reference], val language: Option[LANGUAGES], val provider: Reference, val priority: CodeableConcept, val referral: Option[Reference], val facility: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val fundsReserve: Option[CodeableConcept], val prescription: Option[Reference], val implicitRules: Option[UriStr], val billablePeriod: Option[Period], val modifierExtension: LitSeq[Extension], val originalPrescription: Option[Reference], val payee: Option[Payee], val related: LitSeq[Related], val careTeam: LitSeq[CareTeam], val accident: Option[Accident], val diagnosis: LitSeq[Diagnosis], val procedure: LitSeq[Procedure], val insurance: NonEmptyLitSeq[Insurance], val supportingInfo: LitSeq[SupportingInfo], val item: LitSeq[Item], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.

A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The category of claim, e.g. oral, pharmacy, vision, institutional, professional.
accident
  • Details of an accident which resulted in injuries which required the products and services listed in the claim.
billablePeriod
  • The period for which charges are being submitted.
careTeam
  • The members of the team who provided the products and services.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
created
  • The date this resource was created.
diagnosis
  • Information about diagnoses relevant to the claim items.
enterer
  • Individual who created the claim, predetermination or preauthorization.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
facility
  • Facility where the services were provided.
fundsReserve
  • A code to indicate whether and for whom funds are to be reserved for future claims.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this claim.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
insurance
  • Financial instruments for reimbursement for the health care products and services specified on the claim.
insurer
  • The Insurer who is target of the request.
item
  • A claim line. Either a simple product or service or a 'group' of details which can each be a simple items or groups of sub-details.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
originalPrescription
  • Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.
patient
  • The party to whom the professional services and/or products have been supplied or are being considered and for whom actual or forecast reimbursement is sought.
payee
  • The party to be reimbursed for cost of the products and services according to the terms of the policy.
prescription
  • Prescription to support the dispensing of pharmacy, device or vision products.
priority
  • The provider-required urgency of processing the request. Typical values include: stat, routine deferred.
procedure
  • Procedures performed on the patient relevant to the billing items with the claim.
provider
  • The provider which is responsible for the claim, predetermination or preauthorization.
referral
  • A reference to a referral resource.
related
  • Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.
status
  • The status of the resource instance.
subType
  • A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
supportingInfo
  • Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
total
  • The total value of the all the items in the claim.
use
  • A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.
Constructor:

Introduces the fields use, type, total, status, subType, patient, created, enterer, insurer, provider, priority, referral, facility, identifier, fundsReserve, prescription, billablePeriod, originalPrescription, payee, related, careTeam, accident, diagnosis, procedure, insurance, supportingInfo, item.

Companion:
object
object ClaimResponse extends CompanionFor[ClaimResponse]
Companion:
class
@POJOBoilerplate
class ClaimResponse(val id: Option[String], val use: CLAIM_USE, val meta: Option[Meta], val text: Option[Narrative], `type`: CodeableConcept, val form: Option[Attachment], val status: FM_STATUS, val subType: Option[CodeableConcept], val patient: Reference, val created: FHIRDateTime, val insurer: Reference, val request: Option[Reference], val outcome: REMITTANCE_OUTCOME, val language: Option[LANGUAGES], val formCode: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val requestor: Option[Reference], val payeeType: Option[CodeableConcept], val identifier: LitSeq[Identifier], val preAuthRef: Option[String], val disposition: Option[String], val adjudication: LitSeq[Adjudication], val fundsReserve: Option[CodeableConcept], val implicitRules: Option[UriStr], val preAuthPeriod: Option[Period], val modifierExtension: LitSeq[Extension], val communicationRequest: LitSeq[Reference], val total: LitSeq[Total], val error: LitSeq[Error], val payment: Option[Payment], val processNote: LitSeq[ProcessNote], val insurance: LitSeq[Insurance], val item: LitSeq[Item], val addItem: LitSeq[AddItem], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

This resource provides the adjudication details from the processing of a Claim resource.

This resource provides the adjudication details from the processing of a Claim resource.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
addItem
  • The first-tier service adjudications for payor added product or service lines.
adjudication
  • The adjudication results which are presented at the header level rather than at the line-item or add-item levels.
communicationRequest
  • Request for additional supporting or authorizing information.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
created
  • The date this resource was created.
disposition
  • A human readable description of the status of the adjudication.
error
  • Errors encountered during the processing of the adjudication.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
form
  • The actual form, by reference or inclusion, for printing the content or an EOB.
formCode
  • A code for the form to be used for printing the content.
fundsReserve
  • A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this claim response.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
insurance
  • Financial instruments for reimbursement for the health care products and services specified on the claim.
insurer
  • The party responsible for authorization, adjudication and reimbursement.
item
  • A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
outcome
  • The outcome of the claim, predetermination, or preauthorization processing.
patient
  • The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for facast reimbursement is sought.
payeeType
  • Type of Party to be reimbursed: subscriber, provider, other.
payment
  • Payment details for the adjudication of the claim.
preAuthPeriod
  • The time frame during which this authorization is effective.
preAuthRef
  • Reference from the Insurer which is used in later communications which refers to this adjudication.
processNote
  • A note that describes or explains adjudication results in a human readable form.
request
  • Original request resource reference.
requestor
  • The provider which is responsible for the claim, predetermination or preauthorization.
status
  • The status of the resource instance.
subType
  • A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
total
  • Categorized monetary totals for the adjudication.
use
  • A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.
Constructor:

Introduces the fields use, type, form, status, subType, patient, created, insurer, request, outcome, formCode, requestor, payeeType, identifier, preAuthRef, disposition, adjudication, fundsReserve, preAuthPeriod, communicationRequest, total, error, payment, processNote, insurance, item, addItem.

Companion:
object
object ClinicalImpression extends CompanionFor[ClinicalImpression]
Companion:
class
@POJOBoilerplate
class ClinicalImpression(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val date: Option[FHIRDateTime], val note: LitSeq[Annotation], val status: CLINICALIMPRESSION_STATUS, val subject: Reference, val problem: LitSeq[Reference], val summary: Option[String], val language: Option[LANGUAGES], val assessor: Option[Reference], val previous: Option[Reference], val protocol: LitSeq[UriStr], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val description: Option[String], val statusReason: Option[CodeableConcept], val effective: Option[EffectiveChoice], val implicitRules: Option[UriStr], val supportingInfo: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val prognosisReference: LitSeq[Reference], val prognosisCodeableConcept: LitSeq[CodeableConcept], val finding: LitSeq[Finding], val investigation: LitSeq[Investigation], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.

A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
assessor
  • The clinician performing the assessment.
code
  • Categorizes the type of clinical assessment performed.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
date
  • Indicates when the documentation of the assessment was complete.
description
  • A summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.
effective
  • The point in time or period over which the subject was assessed.
encounter
  • The Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
finding
  • Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
investigation
  • One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.
previous
  • A reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.
problem
  • A list of the relevant problems/conditions for a patient.
prognosisCodeableConcept
  • Estimate of likely outcome.
prognosisReference
  • RiskAssessment expressing likely outcome.
protocol
  • Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.
status
  • Identifies the workflow status of the assessment.
statusReason
  • Captures the reason for the current state of the ClinicalImpression.
subject
  • The patient or group of individuals assessed as part of this record.
summary
  • A text summary of the investigations and the diagnosis.
supportingInfo
  • Information supporting the clinical impression.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, date, note, status, subject, problem, summary, assessor, previous, protocol, encounter, identifier, description, statusReason, effective, supportingInfo, prognosisReference, prognosisCodeableConcept, finding, investigation.

Companion:
object
object CodeSystem extends CompanionFor[CodeSystem]
Companion:
class
@POJOBoilerplate
class CodeSystem(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], val title: Option[String], val count: Option[UnsignedInt], val status: PUBLICATION_STATUS, val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val content: CODESYSTEM_CONTENT_MODE, val language: Option[LANGUAGES], val valueSet: Option[Canonical], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val supplements: Option[Canonical], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val caseSensitive: Option[Boolean], val compositional: Option[Boolean], val versionNeeded: Option[Boolean], val hierarchyMeaning: Option[CODESYSTEM_HIERARCHY_MEANING], val modifierExtension: LitSeq[Extension], val filter: LitSeq[Filter], val property: LitSeq[Property], val concept: LitSeq[Concept], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
caseSensitive
  • If code comparison is case sensitive when codes within this system are compared to each other.
compositional
  • The code system defines a compositional (post-coordination) grammar.
concept
  • Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
content
  • The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
copyright
  • A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.
count
  • The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.
date
  • The date (and optionally time) when the code system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.
description
  • A free text natural language description of the code system from a consumer's perspective.
experimental
  • A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
filter
  • A filter that can be used in a value set compose statement when selecting concepts using a filter.
hierarchyMeaning
  • The meaning of the hierarchy of concepts as represented in this resource.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the code system is intended to be used.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
property
  • A property defines an additional slot through which additional information can be provided about a concept.
publisher
  • The name of the organization or individual that published the code system.
purpose
  • Explanation of why this code system is needed and why it has been designed as it has.
status
  • The date (and optionally time) when the code system resource was created or revised.
supplements
  • The canonical URL of the code system that this code system supplement is adding designations and properties to.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the code system.
url
  • An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in Coding.system.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.
valueSet
  • Canonical reference to the value set that contains the entire code system.
version
  • The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in Coding.version.
versionNeeded
  • This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.
Constructor:

Introduces the fields url, name, date, title, count, status, version, contact, purpose, content, valueSet, publisher, copyright, identifier, useContext, description, supplements, experimental, jurisdiction, caseSensitive, compositional, versionNeeded, hierarchyMeaning, filter, property, concept.

Companion:
object
object Communication extends CompanionFor[Communication]
Companion:
class
@POJOBoilerplate
class Communication(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val sent: Option[FHIRDateTime], val note: LitSeq[Annotation], val topic: Option[CodeableConcept], val about: LitSeq[Reference], val partOf: LitSeq[Reference], val status: EVENT_STATUS, val medium: LitSeq[CodeableConcept], val sender: Option[Reference], val basedOn: LitSeq[Reference], val subject: Option[Reference], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val priority: Option[REQUEST_PRIORITY], val received: Option[FHIRDateTime], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val recipient: LitSeq[Reference], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val inResponseTo: LitSeq[Reference], val statusReason: Option[CodeableConcept], val implicitRules: Option[UriStr], val instantiatesUri: LitSeq[UriStr], val reasonReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val instantiatesCanonical: LitSeq[Canonical], val payload: LitSeq[Payload], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
about
  • Other resources that pertain to this communication and to which this communication should be associated.
basedOn
  • An order, proposal or plan fulfilled in whole or in part by this Communication.
category
  • The type of message conveyed such as alert, notification, reminder, instruction, etc.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
encounter
  • The Encounter during which this Communication was created or to which the creation of this record is tightly associated.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
inResponseTo
  • Prior communication that this communication is in response to.
instantiatesCanonical
  • The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
instantiatesUri
  • The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
language
  • The base language in which the resource is written.
medium
  • A channel that was used for this communication (e.g. email, fax).
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Additional notes or commentary about the communication by the sender, receiver or other interested parties.
partOf
  • Part of this action.
payload
  • Text, attachment(s), or resource(s) that was communicated to the recipient.
priority
  • Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
reasonCode
  • The reason or justification for the communication.
reasonReference
  • Indicates another resource whose existence justifies this communication.
received
  • The time when this communication arrived at the destination.
recipient
  • The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
sender
  • The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
sent
  • The time when this communication was sent.
status
  • The status of the transmission.
statusReason
  • Captures the reason for the current state of the Communication.
subject
  • The patient or group that was the focus of this communication.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
topic
  • Description of the purpose/content, similar to a subject line in an email.
Constructor:

Introduces the fields sent, note, topic, about, partOf, status, medium, sender, basedOn, subject, category, priority, received, encounter, recipient, identifier, reasonCode, inResponseTo, statusReason, instantiatesUri, reasonReference, instantiatesCanonical, payload.

Companion:
object
object CommunicationRequest extends CompanionFor[CommunicationRequest]
Companion:
class
@POJOBoilerplate
class CommunicationRequest(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val note: LitSeq[Annotation], val about: LitSeq[Reference], val status: REQUEST_STATUS, val medium: LitSeq[CodeableConcept], val sender: Option[Reference], val basedOn: LitSeq[Reference], val subject: Option[Reference], val language: Option[LANGUAGES], val replaces: LitSeq[Reference], val category: LitSeq[CodeableConcept], val priority: Option[REQUEST_PRIORITY], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val requester: Option[Reference], val recipient: LitSeq[Reference], val identifier: LitSeq[Identifier], val authoredOn: Option[FHIRDateTime], val reasonCode: LitSeq[CodeableConcept], val statusReason: Option[CodeableConcept], val doNotPerform: Option[Boolean], val implicitRules: Option[UriStr], val occurrence: Option[OccurrenceChoice], val groupIdentifier: Option[Identifier], val reasonReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val payload: LitSeq[Payload], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
about
  • Other resources that pertain to this communication request and to which this communication request should be associated.
authoredOn
  • For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
basedOn
  • A plan or proposal that is fulfilled in whole or in part by this request.
category
  • The type of message to be sent such as alert, notification, reminder, instruction, etc.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
doNotPerform
  • If true indicates that the CommunicationRequest is asking for the specified action to not occur.
encounter
  • The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
groupIdentifier
  • A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
medium
  • A channel that was used for this communication (e.g. email, fax).
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Comments made about the request by the requester, sender, recipient, subject or other participants.
occurrence
  • The time when this communication is to occur.
payload
  • Text, attachment(s), or resource(s) to be communicated to the recipient.
priority
  • Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
reasonCode
  • Describes why the request is being made in coded or textual form.
reasonReference
  • Indicates another resource whose existence justifies this request.
recipient
  • The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
replaces
  • Completed or terminated request(s) whose function is taken by this new request.
requester
  • The device, individual, or organization who initiated the request and has responsibility for its activation.
sender
  • The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
status
  • The status of the proposal or order.
statusReason
  • Captures the reason for the current state of the CommunicationRequest.
subject
  • The patient or group that is the focus of this communication request.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields note, about, status, medium, sender, basedOn, subject, replaces, category, priority, encounter, requester, recipient, identifier, authoredOn, reasonCode, statusReason, doNotPerform, occurrence, groupIdentifier, reasonReference, payload.

Companion:
object
object CompartmentDefinition extends CompanionFor[CompartmentDefinition]
Companion:
class
@POJOBoilerplate
class CompartmentDefinition(val id: Option[String], val url: UriStr, val meta: Option[Meta], val text: Option[Narrative], val name: String, val date: Option[FHIRDateTime], val code: COMPARTMENT_TYPE, val status: PUBLICATION_STATUS, val search: Boolean, val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val resource: LitSeq[Resource], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A compartment definition that defines how resources are accessed on a server.

A compartment definition that defines how resources are accessed on a server.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
code
  • Which compartment this definition describes.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
date
  • The date (and optionally time) when the compartment definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.
description
  • A free text natural language description of the compartment definition from a consumer's perspective.
experimental
  • A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the compartment definition.
purpose
  • Explanation of why this compartment definition is needed and why it has been designed as it has.
resource
  • Information about how a resource is related to the compartment.
search
  • Whether the search syntax is supported,.
status
  • The status of this compartment definition. Enables tracking the life-cycle of the content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
url
  • An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate compartment definition instances.
version
  • The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, code, status, search, version, contact, purpose, publisher, useContext, description, experimental, resource.

Companion:
object
object Composition extends CompanionFor[Composition]
Companion:
class
@POJOBoilerplate
class Composition(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: CodeableConcept, val date: FHIRDateTime, val title: String, val status: COMPOSITION_STATUS, val author: NonEmptyLitSeq[Reference], val subject: Option[Reference], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val custodian: Option[Reference], val identifier: Option[Identifier], val implicitRules: Option[UriStr], val confidentiality: Option[V3_CONFIDENTIALITYCLASSIFICATION], val modifierExtension: LitSeq[Extension], val event: LitSeq[Event], val section: LitSeq[Section], val attester: LitSeq[Attester], val relatesTo: LitSeq[RelatesTo], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
attester
  • A participant who has attested to the accuracy of the composition/document.
author
  • Identifies who is responsible for the information in the composition, not necessarily who typed it in.
category
  • A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
confidentiality
  • The code specifying the level of confidentiality of the Composition.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
custodian
  • Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
date
  • The composition editing time, when the composition was last logically changed by the author.
encounter
  • Describes the clinical encounter or type of care this documentation is associated with.
event
  • The clinical service, such as a colonoscopy or an appendectomy, being documented.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
relatesTo
  • Relationships that this composition has with other compositions or documents that already exist.
section
  • The root of the sections that make up the composition.
status
  • The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
subject
  • Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • Official human-readable label for the composition.
Constructor:

Introduces the fields type, date, title, status, author, subject, category, encounter, custodian, identifier, confidentiality, event, section, attester, relatesTo.

Companion:
object
object ConceptMap extends CompanionFor[ConceptMap]
Companion:
class
@POJOBoilerplate
class ConceptMap(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], val title: Option[String], val status: PUBLICATION_STATUS, val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val source: Option[SourceChoice], val target: Option[TargetChoice], val identifier: Option[Identifier], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val group: LitSeq[Group], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.

A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.
date
  • The date (and optionally time) when the concept map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes.
description
  • A free text natural language description of the concept map from a consumer's perspective.
experimental
  • A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
group
  • A group of mappings that all have the same source and target system.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the concept map is intended to be used.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the concept map.
purpose
  • Explanation of why this concept map is needed and why it has been designed as it has.
source
  • Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.
status
  • The status of this concept map. Enables tracking the life-cycle of the content.
target
  • The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the concept map.
url
  • An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances.
version
  • The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, title, status, version, contact, purpose, publisher, copyright, source, target, identifier, useContext, description, experimental, jurisdiction, group.

Companion:
object
object Condition extends CompanionFor[Condition]
Companion:
class
@POJOBoilerplate
class Condition(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val note: LitSeq[Annotation], val subject: Reference, val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val severity: Option[CodeableConcept], val bodySite: LitSeq[CodeableConcept], val onset: Option[OnsetChoice], val recorder: Option[Reference], val asserter: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val abatement: Option[AbatementChoice], val recordedDate: Option[FHIRDateTime], val implicitRules: Option[UriStr], val clinicalStatus: Option[CodeableConcept], val modifierExtension: LitSeq[Extension], val verificationStatus: Option[CodeableConcept], val stage: LitSeq[Stage], val evidence: LitSeq[Evidence], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
abatement
  • The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate.
asserter
  • Individual who is making the condition statement.
bodySite
  • The anatomical location where this condition manifests itself.
category
  • A category assigned to the condition.
clinicalStatus
  • The clinical status of the condition.
code
  • Identification of the condition, problem or diagnosis.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
encounter
  • The Encounter during which this Condition was created or to which the creation of this record is tightly associated.
evidence
  • Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.
onset
  • Estimated or actual date or date-time the condition began, in the opinion of the clinician.
recordedDate
  • The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.
recorder
  • Individual who recorded the record and takes responsibility for its content.
severity
  • A subjective assessment of the severity of the condition as evaluated by the clinician.
stage
  • Clinical stage or grade of a condition. May include formal severity assessments.
subject
  • Indicates the patient or group who the condition record is associated with.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
verificationStatus
  • The verification status to support the clinical status of the condition.
Constructor:

Introduces the fields code, note, subject, category, severity, bodySite, onset, recorder, asserter, encounter, identifier, abatement, recordedDate, clinicalStatus, verificationStatus, stage, evidence.

Companion:
object
object Consent extends CompanionFor[Consent]
Companion:
class
@POJOBoilerplate
class Consent(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val scope: CodeableConcept, val status: CONSENT_STATE_CODES, val patient: Option[Reference], val language: Option[LANGUAGES], val category: NonEmptyLitSeq[CodeableConcept], val dateTime: Option[FHIRDateTime], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val performer: LitSeq[Reference], val source: Option[SourceChoice], val identifier: LitSeq[Identifier], val policyRule: Option[CodeableConcept], val organization: LitSeq[Reference], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val policy: LitSeq[Policy], val verification: LitSeq[Verification], val provision: Option[Provision], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

A record of a healthcare consumer’s choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
category
  • A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
dateTime
  • When this Consent was issued / created / indexed.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Unique identifier for this copy of the Consent Statement.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
organization
  • The organization that manages the consent, and the framework within which it is executed.
patient
  • The patient/healthcare consumer to whom this consent applies.
performer
  • Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
policy
  • The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
policyRule
  • A reference to the specific base computable regulation or policy.
provision
  • An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
scope
  • A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.
source
  • The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
status
  • Indicates the current state of this consent.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
verification
  • Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.
Constructor:

Introduces the fields scope, status, patient, category, dateTime, performer, source, identifier, policyRule, organization, policy, verification, provision.

Companion:
object
object Contract extends CompanionFor[Contract]
Companion:
class
@POJOBoilerplate
class Contract(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val site: LitSeq[Reference], val name: Option[String], `type`: Option[CodeableConcept], val title: Option[String], val alias: LitSeq[String], val scope: Option[CodeableConcept], val status: Option[CONTRACT_STATUS], val issued: Option[FHIRDateTime], val domain: LitSeq[Reference], val author: Option[Reference], val version: Option[String], val applies: Option[Period], val subject: LitSeq[Reference], val subType: LitSeq[CodeableConcept], val language: Option[LANGUAGES], val subtitle: Option[String], val topic: Option[TopicChoice], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val authority: LitSeq[Reference], val identifier: LitSeq[Identifier], val legalState: Option[CodeableConcept], val implicitRules: Option[UriStr], val expirationType: Option[CodeableConcept], val supportingInfo: LitSeq[Reference], val instantiatesUri: Option[UriStr], val relevantHistory: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val contentDerivative: Option[CodeableConcept], val legallyBinding: Option[LegallyBindingChoice], val instantiatesCanonical: Option[Reference], val rule: LitSeq[Rule], val legal: LitSeq[Legal], val signer: LitSeq[Signer], val friendly: LitSeq[Friendly], val contentDefinition: Option[ContentDefinition], val term: LitSeq[Term], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.

Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • A high-level category for the legal instrument, whether constructed as a Contract definition, derivative, or instance in any legal state. Provides additional information about its content within the context of the Contract's scope to distinguish the kinds of systems that would be interested in the contract.
alias
  • Alternative representation of the title for this Contract definition, derivative, or instance in any legal state., e.g., a domain specific contract number related to legislation.
applies
  • Relevant time or time-period when this Contract is applicable.
author
  • The individual or organization that authored the Contract definition, derivative, or instance in any legal state.
authority
  • A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
contentDefinition
  • Precusory content developed with a focus and intent of supporting the formation a Contract instance, which may be associated with and transformable into a Contract.
contentDerivative
  • The minimal content derived from the basal information source at a specific stage in its lifecycle.
domain
  • Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.
expirationType
  • Event resulting in discontinuation or termination of this Contract instance by one or more parties to the contract.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
friendly
  • The "patient friendly language" versionof the Contract in whole or in parts. "Patient friendly language" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Unique identifier for this Contract or a derivative that references a Source Contract.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
instantiatesCanonical
  • The URL pointing to a FHIR-defined Contract Definition that is adhered to in whole or part by this Contract.
instantiatesUri
  • The URL pointing to an externally maintained definition that is adhered to in whole or in part by this Contract.
issued
  • When this Contract was issued.
language
  • The base language in which the resource is written.
legal
  • List of Legal expressions or representations of this Contract.
legalState
  • Legal states of the formation of a legal instrument, which is a formally executed written document that can be formally attributed to its author, records and formally expresses a legally enforceable act, process, or contractual duty, obligation, or right, and therefore evidences that act, process, or agreement.
legallyBinding
  • Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the "source of truth" and which would be the basis for legal action related to enforcement of this Contract.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying this Contract definition, derivative, or instance in any legal state. Provides additional information about its content. This name should be usable as an identifier for the module by machine processing applications such as code generation.
relevantHistory
  • Links to Provenance records for past versions of this Contract definition, derivative, or instance, which identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the Contract. The Provence.entity indicates the target that was changed in the update. http://build.fhir.org/provenance-definitions.html#Provenance.entity.
rule
  • List of Computable Policy Rule Language Representations of this Contract.
scope
  • A selector of legal concerns for this Contract definition, derivative, or instance in any legal state.
signer
  • Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.
site
  • Sites in which the contract is complied with, exercised, or in force.
status
  • The status of the resource instance.
subType
  • Sub-category for the Contract that distinguishes the kinds of systems that would be interested in the Contract within the context of the Contract's scope.
subject
  • The target entity impacted by or of interest to parties to the agreement.
subtitle
  • An explanatory or alternate user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.
supportingInfo
  • Information that may be needed by/relevant to the performer in their execution of this term action.
term
  • One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for this Contract definition, derivative, or instance in any legal state.t giving additional information about its content.
topic
  • Narrows the range of legal concerns to focus on the achievement of specific contractual objectives.
url
  • Canonical identifier for this contract, represented as a URI (globally unique).
version
  • An edition identifier used for business purposes to label business significant variants.
Constructor:

Introduces the fields url, site, name, type, title, alias, scope, status, issued, domain, author, version, applies, subject, subType, subtitle, topic, authority, identifier, legalState, expirationType, supportingInfo, instantiatesUri, relevantHistory, contentDerivative, legallyBinding, instantiatesCanonical, rule, legal, signer, friendly, contentDefinition, term.

Companion:
object
object Coverage extends CompanionFor[Coverage]
Companion:
class
@POJOBoilerplate
class Coverage(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val payor: NonEmptyLitSeq[Reference], val order: Option[PositiveInt], val status: FM_STATUS, val period: Option[Period], val network: Option[String], val language: Option[LANGUAGES], val contract: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val dependent: Option[String], val identifier: LitSeq[Identifier], val subscriber: Option[Reference], val beneficiary: Reference, val subrogation: Option[Boolean], val policyHolder: Option[Reference], val subscriberId: Option[String], val relationship: Option[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], `class`: LitSeq[Class], val costToBeneficiary: LitSeq[CostToBeneficiary], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`class`
  • A suite of underwriter specific classifiers.
`type`
  • The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
beneficiary
  • The party who benefits from the insurance coverage; the patient when products and/or services are provided.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
contract
  • The policy(s) which constitute this insurance coverage.
costToBeneficiary
  • A suite of codes indicating the cost category and associated amount which have been detailed in the policy and may have been included on the health card.
dependent
  • A unique identifier for a dependent under the coverage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this coverage.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
network
  • The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the 'in-network' rate, otherwise 'out of network' terms and conditions apply.
order
  • The order of applicability of this coverage relative to other coverages which are currently in force. Note, there may be gaps in the numbering and this does not imply primary, secondary etc. as the specific positioning of coverages depends upon the episode of care.
payor
  • The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements.
period
  • Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.
policyHolder
  • The party who 'owns' the insurance policy.
relationship
  • The relationship of beneficiary (patient) to the subscriber.
status
  • The status of the resource instance.
subrogation
  • When 'subrogation=true' this insurance instance has been included not for adjudication but to provide insurers with the details to recover costs.
subscriber
  • The party who has signed-up for or 'owns' the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.
subscriberId
  • The insurer assigned ID for the Subscriber.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, payor, order, status, period, network, contract, dependent, identifier, subscriber, beneficiary, subrogation, policyHolder, subscriberId, relationship, class, costToBeneficiary.

Companion:
object
Companion:
class
@POJOBoilerplate
class CoverageEligibilityRequest(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val status: FM_STATUS, val purpose: NonEmptyLitSeq[ELIGIBILITYREQUEST_PURPOSE], val patient: Reference, val created: FHIRDateTime, val enterer: Option[Reference], val insurer: Reference, val language: Option[LANGUAGES], val priority: Option[CodeableConcept], val provider: Option[Reference], val facility: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val serviced: Option[ServicedChoice], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val insurance: LitSeq[Insurance], val supportingInfo: LitSeq[SupportingInfo], val item: LitSeq[Item], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.

The CoverageEligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an CoverageEligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
created
  • The date when this resource was created.
enterer
  • Person who created the request.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
facility
  • Facility where the services are intended to be provided.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this coverage eligiblity request.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
insurance
  • Financial instruments for reimbursement for the health care products and services.
insurer
  • The Insurer who issued the coverage in question and is the recipient of the request.
item
  • Service categories or billable services for which benefit details and/or an authorization prior to service delivery may be required by the payor.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
patient
  • The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.
priority
  • When the requestor expects the processor to complete processing.
provider
  • The provider which is responsible for the request.
purpose
  • Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.
serviced
  • The date or dates when the enclosed suite of services were performed or completed.
status
  • The status of the resource instance.
supportingInfo
  • Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields status, purpose, patient, created, enterer, insurer, priority, provider, facility, identifier, serviced, insurance, supportingInfo, item.

Companion:
object
Companion:
class
@POJOBoilerplate
class CoverageEligibilityResponse(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val form: Option[CodeableConcept], val status: FM_STATUS, val purpose: NonEmptyLitSeq[ELIGIBILITYRESPONSE_PURPOSE], val patient: Reference, val created: FHIRDateTime, val request: Reference, val outcome: REMITTANCE_OUTCOME, val insurer: Reference, val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val requestor: Option[Reference], val identifier: LitSeq[Identifier], val preAuthRef: Option[String], val serviced: Option[ServicedChoice], val disposition: Option[String], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val error: LitSeq[Error], val insurance: LitSeq[Insurance], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.

This resource provides eligibility and plan details from the processing of an CoverageEligibilityRequest resource.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
created
  • The date this resource was created.
disposition
  • A human readable description of the status of the adjudication.
error
  • Errors encountered during the processing of the request.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
form
  • A code for the form to be used for printing the content.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this coverage eligiblity request.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
insurance
  • Financial instruments for reimbursement for the health care products and services.
insurer
  • The Insurer who issued the coverage in question and is the author of the response.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
outcome
  • The outcome of the request processing.
patient
  • The party who is the beneficiary of the supplied coverage and for whom eligibility is sought.
preAuthRef
  • A reference from the Insurer to which these services pertain to be used on further communication and as proof that the request occurred.
purpose
  • Code to specify whether requesting: prior authorization requirements for some service categories or billing codes; benefits for coverages specified or discovered; discovery and return of coverages for the patient; and/or validation that the specified coverage is in-force at the date/period specified or 'now' if not specified.
request
  • Reference to the original request resource.
requestor
  • The provider which is responsible for the request.
serviced
  • The date or dates when the enclosed suite of services were performed or completed.
status
  • The status of the resource instance.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields form, status, purpose, patient, created, request, outcome, insurer, requestor, identifier, preAuthRef, serviced, disposition, error, insurance.

Companion:
object
object DetectedIssue extends CompanionFor[DetectedIssue]
Companion:
class
@POJOBoilerplate
class DetectedIssue(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val status: OBSERVATION_STATUS, val author: Option[Reference], val detail: Option[String], val patient: Option[Reference], val language: Option[LANGUAGES], val severity: Option[DETECTEDISSUE_SEVERITY], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val reference: Option[UriStr], val identifier: LitSeq[Identifier], val implicated: LitSeq[Reference], val implicitRules: Option[UriStr], val identified: Option[IdentifiedChoice], val modifierExtension: LitSeq[Extension], val evidence: LitSeq[Evidence], val mitigation: LitSeq[Mitigation], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.

Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
author
  • Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
code
  • Identifies the general type of issue identified.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
detail
  • A textual explanation of the detected issue.
evidence
  • Supporting evidence or manifestations that provide the basis for identifying the detected issue such as a GuidanceResponse or MeasureReport.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identified
  • The date or period when the detected issue was initially identified.
identifier
  • Business identifier associated with the detected issue record.
implicated
  • Indicates the resource representing the current activity or proposed activity that is potentially problematic.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
mitigation
  • Indicates an action that has been taken or is committed to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
patient
  • Indicates the patient whose record the detected issue is associated with.
reference
  • The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
severity
  • Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
status
  • Indicates the status of the detected issue.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, status, author, detail, patient, severity, reference, identifier, implicated, identified, evidence, mitigation.

Companion:
object
object Device extends CompanionFor[Device]
Companion:
class
@POJOBoilerplate
class Device(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val note: LitSeq[Annotation], val owner: Option[Reference], val status: Option[DEVICE_STATUS], val safety: LitSeq[CodeableConcept], val parent: Option[Reference], val patient: Option[Reference], val contact: LitSeq[ContactPoint], val language: Option[LANGUAGES], val location: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val lotNumber: Option[String], val identifier: LitSeq[Identifier], val definition: Option[Reference], val partNumber: Option[String], val modelNumber: Option[String], val statusReason: LitSeq[CodeableConcept], val manufacturer: Option[String], val serialNumber: Option[String], val implicitRules: Option[UriStr], val expirationDate: Option[FHIRDateTime], val manufactureDate: Option[FHIRDateTime], val modifierExtension: LitSeq[Extension], val distinctIdentifier: Option[String], val version: LitSeq[Version], val property: LitSeq[Property], val udiCarrier: LitSeq[UdiCarrier], val deviceName: LitSeq[DeviceName], val specialization: LitSeq[Specialization], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The kind or type of device.
contact
  • Contact details for an organization or a particular human that is responsible for the device.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
definition
  • The reference to the definition for the device.
deviceName
  • This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.
distinctIdentifier
  • The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
expirationDate
  • The date and time beyond which this device is no longer valid or should not be used (if applicable).
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
location
  • The place where the device can be found.
lotNumber
  • Lot number assigned by the manufacturer.
manufactureDate
  • The date and time when the device was manufactured.
manufacturer
  • A name of the manufacturer.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modelNumber
  • The model number for the device.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Descriptive information, usage information or implantation information that is not captured in an existing element.
owner
  • An organization that is responsible for the provision and ongoing maintenance of the device.
parent
  • The parent device.
partNumber
  • The part number of the device.
patient
  • Patient information, If the device is affixed to a person.
property
  • The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
safety
  • Provides additional safety characteristics about a medical device. For example devices containing latex.
serialNumber
  • The serial number assigned by the organization when the device was manufactured.
specialization
  • The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
status
  • Status of the Device availability.
statusReason
  • Reason for the dtatus of the Device availability.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
udiCarrier
  • Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
url
  • A network address on which the device may be contacted directly.
version
  • The actual design of the device or software version running on the device.
Constructor:

Introduces the fields url, type, note, owner, status, safety, parent, patient, contact, location, lotNumber, identifier, definition, partNumber, modelNumber, statusReason, manufacturer, serialNumber, expirationDate, manufactureDate, distinctIdentifier, version, property, udiCarrier, deviceName, specialization.

Companion:
object
object DeviceDefinition extends CompanionFor[DeviceDefinition]
Companion:
class
@POJOBoilerplate
class DeviceDefinition(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val note: LitSeq[Annotation], val owner: Option[Reference], val safety: LitSeq[CodeableConcept], val version: LitSeq[String], val contact: LitSeq[ContactPoint], val language: Option[LANGUAGES], val quantity: Option[Quantity], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val modelNumber: Option[String], val languageCode: LitSeq[CodeableConcept], val parentDevice: Option[Reference], val implicitRules: Option[UriStr], val manufacturer: Option[ManufacturerChoice], val shelfLifeStorage: LitSeq[Choice["ProductShelfLife"]], val modifierExtension: LitSeq[Extension], val onlineInformation: Option[UriStr], val physicalCharacteristics: Option[Choice["ProdCharacteristic"]], val property: LitSeq[Property], val deviceName: LitSeq[DeviceName], val capability: LitSeq[Capability], val material: LitSeq[Material], val specialization: LitSeq[Specialization], val udiDeviceIdentifier: LitSeq[UdiDeviceIdentifier], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The characteristics, operational status and capabilities of a medical-related component of a medical device.

The characteristics, operational status and capabilities of a medical-related component of a medical device.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • What kind of device or device system this is.
capability
  • Device capabilities.
contact
  • Contact details for an organization or a particular human that is responsible for the device.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
deviceName
  • A name given to the device to identify it.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
languageCode
  • Language code for the human-readable text strings produced by the device (all supported).
manufacturer
  • A name of the manufacturer.
material
  • A substance used to create the material(s) of which the device is made.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modelNumber
  • The model number for the device.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Descriptive information, usage information or implantation information that is not captured in an existing element.
onlineInformation
  • Access to on-line information about the device.
owner
  • An organization that is responsible for the provision and ongoing maintenance of the device.
parentDevice
  • The parent device it can be part of.
physicalCharacteristics
  • Dimensions, color etc.
property
  • The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
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).
safety
  • Safety characteristics of the device.
shelfLifeStorage
  • Shelf Life and storage information.
specialization
  • The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
udiDeviceIdentifier
  • Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
url
  • A network address on which the device may be contacted directly.
version
  • The available versions of the device, e.g., software versions.
Constructor:

Introduces the fields url, type, note, owner, safety, version, contact, quantity, identifier, modelNumber, languageCode, parentDevice, manufacturer, shelfLifeStorage, onlineInformation, physicalCharacteristics, property, deviceName, capability, material, specialization, udiDeviceIdentifier.

Companion:
object
object DeviceMetric extends CompanionFor[DeviceMetric]
Companion:
class
@POJOBoilerplate
class DeviceMetric(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: CodeableConcept, val unit: Option[CodeableConcept], val color: Option[METRIC_COLOR], val source: Option[Reference], val parent: Option[Reference], val language: Option[LANGUAGES], val category: METRIC_CATEGORY, val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val operationalStatus: Option[METRIC_OPERATIONAL_STATUS], val measurementPeriod: Option[Timing], val calibration: LitSeq[Calibration], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Describes a measurement, calculation or setting capability of a medical device.

Describes a measurement, calculation or setting capability of a medical device.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
calibration
  • Describes the calibrations that have been performed or that are required to be performed.
category
  • Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
color
  • Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
measurementPeriod
  • Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
operationalStatus
  • Indicates current operational state of the device. For example: On, Off, Standby, etc.
parent
  • Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.
source
  • Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
unit
  • Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
Constructor:

Introduces the fields type, unit, color, source, parent, category, identifier, operationalStatus, measurementPeriod, calibration.

Companion:
object
object DeviceRequest extends CompanionFor[DeviceRequest]
Companion:
class
@POJOBoilerplate
class DeviceRequest(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val note: LitSeq[Annotation], val status: Option[REQUEST_STATUS], val intent: REQUEST_INTENT, val basedOn: LitSeq[Reference], val code: CodeChoice, val subject: Reference, val language: Option[LANGUAGES], val priority: Option[REQUEST_PRIORITY], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val requester: Option[Reference], val performer: Option[Reference], val insurance: LitSeq[Reference], val identifier: LitSeq[Identifier], val authoredOn: Option[FHIRDateTime], val reasonCode: LitSeq[CodeableConcept], val priorRequest: LitSeq[Reference], val implicitRules: Option[UriStr], val occurrence: Option[OccurrenceChoice], val performerType: Option[CodeableConcept], val supportingInfo: LitSeq[Reference], val instantiatesUri: LitSeq[UriStr], val groupIdentifier: Option[Identifier], val reasonReference: LitSeq[Reference], val relevantHistory: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val instantiatesCanonical: LitSeq[Canonical], val parameter: LitSeq[Parameter], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.

Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
authoredOn
  • When the request transitioned to being actionable.
basedOn
  • Plan/proposal/order fulfilled by this request.
code
  • The details of the device to be used.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
encounter
  • An encounter that provides additional context in which this request is made.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
groupIdentifier
  • Composite request this is part of.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers assigned to this order by the orderer or by the receiver.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
instantiatesCanonical
  • The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
instantiatesUri
  • The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
insurance
  • Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
intent
  • Whether the request is a proposal, plan, an original order or a reflex order.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.
occurrence
  • The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".
parameter
  • Specific parameters for the ordered item. For example, the prism value for lenses.
performer
  • The desired performer for doing the diagnostic testing.
performerType
  • Desired type of performer for doing the diagnostic testing.
priorRequest
  • The request takes the place of the referenced completed or terminated request(s).
priority
  • Indicates how quickly the {{title}} should be addressed with respect to other requests.
reasonCode
  • Reason or justification for the use of this device.
reasonReference
  • Reason or justification for the use of this device.
relevantHistory
  • Key events in the history of the request.
requester
  • The individual who initiated the request and has responsibility for its activation.
status
  • The status of the request.
subject
  • The patient who will use the device.
supportingInfo
  • Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields note, status, intent, basedOn, code, subject, priority, encounter, requester, performer, insurance, identifier, authoredOn, reasonCode, priorRequest, occurrence, performerType, supportingInfo, instantiatesUri, groupIdentifier, reasonReference, relevantHistory, instantiatesCanonical, parameter.

Companion:
object
object DeviceUseStatement extends CompanionFor[DeviceUseStatement]
Companion:
class
@POJOBoilerplate
class DeviceUseStatement(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val note: LitSeq[Annotation], val status: DEVICE_STATEMENT_STATUS, val source: Option[Reference], val device: Reference, val basedOn: LitSeq[Reference], val subject: Reference, val language: Option[LANGUAGES], val bodySite: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val timing: Option[TimingChoice], val identifier: LitSeq[Identifier], val recordedOn: Option[FHIRDateTime], val reasonCode: LitSeq[CodeableConcept], val derivedFrom: LitSeq[Reference], val implicitRules: Option[UriStr], val reasonReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.

A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
basedOn
  • A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.
bodySite
  • Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
derivedFrom
  • Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.
device
  • The details of the device used.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • An external identifier for this statement such as an IRI.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.
reasonCode
  • Reason or justification for the use of the device.
reasonReference
  • Indicates another resource whose existence justifies this DeviceUseStatement.
recordedOn
  • The time at which the statement was made/recorded.
source
  • Who reported the device was being used by the patient.
status
  • A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.
subject
  • The patient who used the device.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
timing
  • How often the device was used.
Constructor:

Introduces the fields note, status, source, device, basedOn, subject, bodySite, timing, identifier, recordedOn, reasonCode, derivedFrom, reasonReference.

Companion:
object
object DiagnosticReport extends CompanionFor[DiagnosticReport]
Companion:
class
@POJOBoilerplate
class DiagnosticReport(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: CodeableConcept, val status: DIAGNOSTIC_REPORT_STATUS, val issued: Option[ZonedDateTime], val result: LitSeq[Reference], val basedOn: LitSeq[Reference], val subject: Option[Reference], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val specimen: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val performer: LitSeq[Reference], val identifier: LitSeq[Identifier], val conclusion: Option[String], val effective: Option[EffectiveChoice], val imagingStudy: LitSeq[Reference], val implicitRules: Option[UriStr], val presentedForm: LitSeq[Attachment], val conclusionCode: LitSeq[CodeableConcept], val modifierExtension: LitSeq[Extension], val resultsInterpreter: LitSeq[Reference], val media: LitSeq[Media], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.

The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
basedOn
  • Details concerning a service requested.
category
  • A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.
code
  • A code or name that describes this diagnostic report.
conclusion
  • Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.
conclusionCode
  • One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
effective
  • The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
encounter
  • The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers assigned to this report by the performer or other systems.
imagingStudy
  • One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
issued
  • The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.
language
  • The base language in which the resource is written.
media
  • A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
performer
  • The diagnostic service that is responsible for issuing the report.
presentedForm
  • Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
result
resultsInterpreter
  • The practitioner or organization that is responsible for the report's conclusions and interpretations.
specimen
  • Details about the specimens on which this diagnostic report is based.
status
  • The status of the diagnostic report.
subject
  • The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, status, issued, result, basedOn, subject, category, specimen, encounter, performer, identifier, conclusion, effective, imagingStudy, presentedForm, conclusionCode, resultsInterpreter, media.

Companion:
object
object DocumentManifest extends CompanionFor[DocumentManifest]
Companion:
class
@POJOBoilerplate
class DocumentManifest(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val status: DOCUMENT_REFERENCE_STATUS, val author: LitSeq[Reference], val source: Option[UriStr], val subject: Option[Reference], val created: Option[FHIRDateTime], val content: NonEmptyLitSeq[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val recipient: LitSeq[Reference], val identifier: LitSeq[Identifier], val description: Option[String], val implicitRules: Option[UriStr], val masterIdentifier: Option[Identifier], val modifierExtension: LitSeq[Extension], val related: LitSeq[Related], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A collection of documents compiled for a purpose together with metadata that applies to the collection.

A collection of documents compiled for a purpose together with metadata that applies to the collection.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.
author
  • Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
content
  • The list of Resources that consist of the parts of this manifest.
created
  • When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
description
  • Human-readable description of the source document. This is sometimes known as the "title".
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Other identifiers associated with the document manifest, including version independent identifiers.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
masterIdentifier
  • A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
recipient
  • A patient, practitioner, or organization for which this set of documents is intended.
related
  • Related identifiers or resources associated with the DocumentManifest.
source
  • Identifies the source system, application, or software that produced the document manifest.
status
  • The status of this document manifest.
subject
  • Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, status, author, source, subject, created, content, recipient, identifier, description, masterIdentifier, related.

Companion:
object
object DocumentReference extends CompanionFor[DocumentReference]
Companion:
class
@POJOBoilerplate
class DocumentReference(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val date: Option[ZonedDateTime], val status: DOCUMENT_REFERENCE_STATUS, val author: LitSeq[Reference], val subject: Option[Reference], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val docStatus: Option[COMPOSITION_STATUS], val custodian: Option[Reference], val identifier: LitSeq[Identifier], val description: Option[String], val implicitRules: Option[UriStr], val authenticator: Option[Reference], val securityLabel: LitSeq[CodeableConcept], val masterIdentifier: Option[Identifier], val modifierExtension: LitSeq[Extension], val content: NonEmptyLitSeq[Content], val context: Option[Context], val relatesTo: LitSeq[RelatesTo], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
authenticator
  • Which person or organization authenticates that this document is valid.
author
  • Identifies who is responsible for adding the information to the document.
category
  • A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
content
  • The document and format referenced. There may be multiple content element repetitions, each with a different format.
context
  • The clinical context in which the document was prepared.
custodian
  • Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
date
  • When the document reference was created.
description
  • Human-readable description of the source document.
docStatus
  • The status of the underlying document.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Other identifiers associated with the document, including version independent identifiers.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
masterIdentifier
  • Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
relatesTo
  • Relationships that this document has with other document references that already exist.
securityLabel
  • A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
status
  • The status of this document reference.
subject
  • Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, date, status, author, subject, category, docStatus, custodian, identifier, description, authenticator, securityLabel, masterIdentifier, content, context, relatesTo.

Companion:
object
object DomainResource extends CompanionFor[DomainResource]
Companion:
class
@POJOBoilerplate
class DomainResource(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Resource

A resource that includes narrative, extensions, and contained resources.

A resource that includes narrative, extensions, and contained resources.

Subclass of core.model.Resource (This is the base resource type for everything.)

Value parameters:
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields text, contained, extension, modifierExtension.

Companion:
object
Companion:
class
@POJOBoilerplate
class EffectEvidenceSynthesis(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], val note: LitSeq[Annotation], val title: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val version: Option[String], val contact: LitSeq[ContactDetail], val outcome: Reference, val language: Option[LANGUAGES], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val exposure: Reference, val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val studyType: Option[CodeableConcept], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], val population: Reference, val description: Option[Markdown], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val synthesisType: Option[CodeableConcept], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val modifierExtension: LitSeq[Extension], val exposureAlternative: Reference, val sampleSize: Option[SampleSize], val resultsByExposure: LitSeq[ResultsByExposure], val certainty: LitSeq[Certainty], val effectEstimate: LitSeq[EffectEstimate], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.

The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
certainty
  • A description of the certainty of the effect estimate.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the effect evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the effect evidence synthesis.
date
  • The date (and optionally time) when the effect evidence synthesis was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the effect evidence synthesis changes.
description
  • A free text natural language description of the effect evidence synthesis from a consumer's perspective.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectEstimate
  • The estimated effect of the exposure variant.
effectivePeriod
  • The period during which the effect evidence synthesis content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
exposure
  • A reference to a EvidenceVariable resource that defines the exposure for the research.
exposureAlternative
  • A reference to a EvidenceVariable resource that defines the comparison exposure for the research.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this effect evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the effect evidence synthesis is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the effect evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation.
note
  • A human-readable string to clarify or explain concepts about the resource.
outcome
  • A reference to a EvidenceVariable resomece that defines the outcome for the research.
population
  • A reference to a EvidenceVariable resource that defines the population for the research.
publisher
  • The name of the organization or individual that published the effect evidence synthesis.
relatedArtifact
  • Related artifacts such as additional documentation, justification, or bibliographic references.
resultsByExposure
  • A description of the results for each exposure considered in the effect estimate.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
sampleSize
  • A description of the size of the sample involved in the synthesis.
status
  • The status of this effect evidence synthesis. Enables tracking the life-cycle of the content.
studyType
  • Type of study eg randomized trial.
synthesisType
  • Type of synthesis eg meta-analysis.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the effect evidence synthesis.
topic
  • Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.
url
  • An absolute URI that is used to identify this effect evidence synthesis when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this effect evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the effect evidence synthesis is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate effect evidence synthesis instances.
version
  • The identifier that is used to identify this version of the effect evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the effect evidence synthesis author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, note, title, topic, status, author, editor, version, contact, outcome, reviewer, endorser, exposure, publisher, copyright, studyType, identifier, useContext, population, description, jurisdiction, approvalDate, synthesisType, lastReviewDate, effectivePeriod, relatedArtifact, exposureAlternative, sampleSize, resultsByExposure, certainty, effectEstimate.

Companion:
object
object ElementDefinition extends CompanionFor[ElementDefinition]
Companion:
class
@POJOBoilerplate
class ElementDefinition(val id: Option[String], val min: Option[UnsignedInt], val max: Option[String], val path: String, val code: LitSeq[Coding], val label: Option[String], val short: Option[String], val alias: LitSeq[String], val comment: Option[Markdown], val fixed: Option[FixedChoice], val extension: LitSeq[Extension], val sliceName: Option[String], val maxLength: Option[Int], val condition: LitSeq[Id], val isSummary: Option[Boolean], val definition: Option[Markdown], val pattern: Option[PatternChoice], val isModifier: Option[Boolean], val minValue: Option[MinValueChoice], val maxValue: Option[MaxValueChoice], val mustSupport: Option[Boolean], val requirements: Option[Markdown], val orderMeaning: Option[String], val representation: LitSeq[PROPERTY_REPRESENTATION], val base: Option[Base], val defaultValue: Option[DefaultValueChoice], val contentReference: Option[UriStr], val isModifierReason: Option[String], val modifierExtension: LitSeq[Extension], val example: LitSeq[Example], val mapping: LitSeq[Mapping], `type`: LitSeq[Type], val meaningWhenMissing: Option[Markdown], val sliceIsConstraining: Option[Boolean], val binding: Option[Binding], val constraint: LitSeq[Constraint], val slicing: Option[Slicing], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends BackboneElement

Base StructureDefinition for ElementDefinition Type: Captures constraints on each element within the resource, profile, or extension.

Base StructureDefinition for ElementDefinition Type: Captures constraints on each element within the resource, profile, or extension.

Subclass of core.model.BackboneElement (Base StructureDefinition for BackboneElement Type: Base definition for all elements that are defined inside a resource - but not those in a data type.)

Value parameters:
`type`
  • The data type or resource that the value of this element is permitted to be.
alias
  • Identifies additional names by which this element might also be known.
base
  • Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same.
binding
  • Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).
code
  • A code that has the same meaning as the element in a particular terminology.
comment
  • Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc. (Note: The text you are reading is specified in ElementDefinition.comment).
condition
  • A reference to an invariant that may make additional statements about the cardinality or value in the instance.
constraint
  • Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.
contentReference
  • Identifies an element defined elsewhere in the definition whose content rules should be applied to the current element. ContentReferences bring across all the rules that are in the ElementDefinition for the element, including definitions, cardinality constraints, bindings, invariants etc.
defaultValue
  • The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').
definition
  • Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource. (Note: The text you are reading is specified in ElementDefinition.definition).
example
  • A sample value for this element demonstrating the type of information that would typically be found in the element.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
fixed
  • Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
isModifier
  • If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.
isModifierReason
  • Explains how that element affects the interpretation of the resource or element that contains it.
isSummary
  • Whether the element should be included if a client requests a search with the parameter _summary=true.
label
  • A single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.
mapping
  • Identifies a concept from an external specification that roughly corresponds to this element.
max
  • The maximum number of times this element is permitted to appear in the instance.
maxLength
  • Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element.
maxValue
  • The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
meaningWhenMissing
  • The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing').
min
  • The minimum number of times this element SHALL appear in the instance.
minValue
  • The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
mustSupport
  • If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way. If false, the element may be ignored and not supported. If false, whether to populate or use the data element in any way is at the discretion of the implementation.
orderMeaning
  • If present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning.
path
  • The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension.
pattern
  • Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,
  1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value
  2. If an array: it must match (recursively) the pattern value.
representation
  • Codes that define how this element is represented in instances, when the deviation varies from the normal case.
requirements
  • This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element.
short
  • A concise description of what this element means (e.g. for use in autogenerated summaries).
sliceIsConstraining
  • If true, indicates that this slice definition is constraining a slice definition with the same name in an inherited profile. If false, the slice is not overriding any slice in an inherited profile. If missing, the slice might or might not be overriding a slice in an inherited profile, depending on the sliceName.
sliceName
  • The name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element.
slicing
  • Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).
Constructor:

Introduces the fields min, max, path, code, label, short, alias, comment, fixed, sliceName, maxLength, condition, isSummary, definition, pattern, isModifier, minValue, maxValue, mustSupport, requirements, orderMeaning, representation, base, defaultValue, contentReference, isModifierReason, example, mapping, type, meaningWhenMissing, sliceIsConstraining, binding, constraint, slicing.

Companion:
object
object Encounter extends CompanionFor[Encounter]
Companion:
class
@POJOBoilerplate
class Encounter(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: LitSeq[CodeableConcept], `class`: Coding, val status: ENCOUNTER_STATUS, val period: Option[Period], val length: Option[Duration], val partOf: Option[Reference], val subject: Option[Reference], val basedOn: LitSeq[Reference], val account: LitSeq[Reference], val language: Option[LANGUAGES], val priority: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val serviceType: Option[CodeableConcept], val appointment: LitSeq[Reference], val implicitRules: Option[UriStr], val episodeOfCare: LitSeq[Reference], val reasonReference: LitSeq[Reference], val serviceProvider: Option[Reference], val modifierExtension: LitSeq[Extension], val location: LitSeq[Location], val diagnosis: LitSeq[Diagnosis], val participant: LitSeq[Participant], val classHistory: LitSeq[ClassHistory], val statusHistory: LitSeq[StatusHistory], val hospitalization: Option[Hospitalization], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`class`
  • Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
`type`
  • Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
account
  • The set of accounts that may be used for billing for this Encounter.
appointment
  • The appointment that scheduled this encounter.
basedOn
  • The request this encounter satisfies (e.g. incoming referral or procedure request).
classHistory
  • The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
diagnosis
  • The list of diagnosis relevant to this encounter.
episodeOfCare
  • Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
hospitalization
  • Details about the admission to a healthcare service.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifier(s) by which this encounter is known.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
length
  • Quantity of time the encounter lasted. This excludes the time during leaves of absence.
location
  • List of locations where the patient has been during this encounter.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
partOf
  • Another Encounter of which this encounter is a part of (administratively or in time).
participant
  • The list of people responsible for providing the service.
period
  • The start and end time of the encounter.
priority
  • Indicates the urgency of the encounter.
reasonCode
  • Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
reasonReference
  • Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
serviceProvider
  • The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.
serviceType
  • Broad categorization of the service that is to be provided (e.g. cardiology).
status
  • planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
statusHistory
  • The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
subject
  • The patient or group present at the encounter.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, class, status, period, length, partOf, subject, basedOn, account, priority, identifier, reasonCode, serviceType, appointment, episodeOfCare, reasonReference, serviceProvider, location, diagnosis, participant, classHistory, statusHistory, hospitalization.

Companion:
object
object Endpoint extends CompanionFor[Endpoint]
Companion:
class
@POJOBoilerplate
class Endpoint(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val status: ENDPOINT_STATUS, val period: Option[Period], val header: LitSeq[String], val contact: LitSeq[ContactPoint], val address: UrlStr, val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val payloadType: NonEmptyLitSeq[CodeableConcept], val implicitRules: Option[UriStr], val connectionType: Coding, val payloadMimeType: LitSeq[Code], val modifierExtension: LitSeq[Extension], val managingOrganization: Option[Reference], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.

The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
address
  • The uri that describes the actual end-point to connect to.
connectionType
  • A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
contact
  • Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
header
  • Additional headers / information to send as part of the notification.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
managingOrganization
  • The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A friendly name that this endpoint can be referred to with.
payloadMimeType
  • The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
payloadType
  • The payload type describes the acceptable content that can be communicated on the endpoint.
period
  • The interval during which the endpoint is expected to be operational.
status
  • active | suspended | error | off | test.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields name, status, period, header, contact, address, identifier, payloadType, connectionType, payloadMimeType, managingOrganization.

Companion:
object
object EnrollmentRequest extends CompanionFor[EnrollmentRequest]
Companion:
class
@POJOBoilerplate
class EnrollmentRequest(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val status: Option[FM_STATUS], val created: Option[FHIRDateTime], val insurer: Option[Reference], val language: Option[LANGUAGES], val provider: Option[Reference], val coverage: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val candidate: Option[Reference], val identifier: LitSeq[Identifier], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

This resource provides the insurance enrollment details to the insurer regarding a specified coverage.

This resource provides the insurance enrollment details to the insurer regarding a specified coverage.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
candidate
  • Patient Resource.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
coverage
  • Reference to the program or plan identification, underwriter or payor.
created
  • The date when this resource was created.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • The Response business identifier.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
insurer
  • The Insurer who is target of the request.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
provider
  • The practitioner who is responsible for the services rendered to the patient.
status
  • The status of the resource instance.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields status, created, insurer, provider, coverage, candidate, identifier.

Companion:
object
object EnrollmentResponse extends CompanionFor[EnrollmentResponse]
Companion:
class
@POJOBoilerplate
class EnrollmentResponse(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val status: Option[FM_STATUS], val request: Option[Reference], val outcome: Option[REMITTANCE_OUTCOME], val created: Option[FHIRDateTime], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val disposition: Option[String], val organization: Option[Reference], val implicitRules: Option[UriStr], val requestProvider: Option[Reference], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.

This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
created
  • The date when the enclosed suite of services were performed or completed.
disposition
  • A description of the status of the adjudication.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • The Response business identifier.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
organization
  • The Insurer who produced this adjudicated response.
outcome
  • Processing status: error, complete.
request
  • Original request resource reference.
requestProvider
  • The practitioner who is responsible for the services rendered to the patient.
status
  • The status of the resource instance.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields status, request, outcome, created, identifier, disposition, organization, requestProvider.

Companion:
object
object EpisodeOfCare extends CompanionFor[EpisodeOfCare]
Companion:
class
@POJOBoilerplate
class EpisodeOfCare(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: LitSeq[CodeableConcept], val team: LitSeq[Reference], val status: EPISODE_OF_CARE_STATUS, val period: Option[Period], val patient: Reference, val account: LitSeq[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val careManager: Option[Reference], val implicitRules: Option[UriStr], val referralRequest: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val managingOrganization: Option[Reference], val diagnosis: LitSeq[Diagnosis], val statusHistory: LitSeq[StatusHistory], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.

An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.
account
  • The set of accounts that may be used for billing for this EpisodeOfCare.
careManager
  • The practitioner that is the care manager/care coordinator for this patient.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
diagnosis
  • The list of diagnosis relevant to this episode of care.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
managingOrganization
  • The organization that has assumed the specific responsibilities for the specified duration.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
patient
  • The patient who is the focus of this episode of care.
period
  • The interval during which the managing organization assumes the defined responsibility.
referralRequest
  • Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.
status
  • planned | waitlist | active | onhold | finished | cancelled.
statusHistory
  • The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).
team
  • The list of practitioners that may be facilitating this episode of care for specific purposes.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, team, status, period, patient, account, identifier, careManager, referralRequest, managingOrganization, diagnosis, statusHistory.

Companion:
object
object EventDefinition extends CompanionFor[EventDefinition]
Companion:
class
@POJOBoilerplate
class EventDefinition(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], val title: Option[String], val usage: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val trigger: NonEmptyLitSeq[TriggerDefinition], val language: Option[LANGUAGES], val subtitle: Option[String], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val subject: Option[SubjectChoice], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The EventDefinition resource provides a reusable description of when a particular event can occur.

The EventDefinition resource provides a reusable description of when a particular event can occur.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the event definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the event definition.
date
  • The date (and optionally time) when the event definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the event definition changes.
description
  • A free text natural language description of the event definition from a consumer's perspective.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectivePeriod
  • The period during which the event definition content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
experimental
  • A Boolean value to indicate that this event definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the event definition is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the event definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the event definition.
purpose
  • Explanation of why this event definition is needed and why it has been designed as it has.
relatedArtifact
  • Related resources such as additional documentation, justification, or bibliographic references.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
status
  • The status of this event definition. Enables tracking the life-cycle of the content.
subject
  • A code or group definition that describes the intended subject of the event definition.
subtitle
  • An explanatory or alternate title for the event definition giving additional information about its content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the event definition.
topic
  • Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
trigger
  • The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.
url
  • An absolute URI that is used to identify this event definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this event definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the event definition is stored on different servers.
usage
  • A detailed description of how the event definition is used from a clinical perspective.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate event definition instances.
version
  • The identifier that is used to identify this version of the event definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the event definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, title, usage, topic, status, author, editor, version, contact, purpose, trigger, subtitle, reviewer, endorser, publisher, copyright, identifier, subject, useContext, description, experimental, jurisdiction, approvalDate, lastReviewDate, effectivePeriod, relatedArtifact.

Companion:
object
object Evidence extends CompanionFor[Evidence]
Companion:
class
@POJOBoilerplate
class Evidence(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], val note: LitSeq[Annotation], val title: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val version: Option[String], val contact: LitSeq[ContactDetail], val outcome: LitSeq[Reference], val language: Option[LANGUAGES], val subtitle: Option[String], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val shortTitle: Option[String], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val exposureVariant: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val exposureBackground: Reference, val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The Evidence resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.

The Evidence resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the evidence and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence.
date
  • The date (and optionally time) when the evidence was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence changes.
description
  • A free text natural language description of the evidence from a consumer's perspective.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectivePeriod
  • The period during which the evidence content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
exposureBackground
  • A reference to a EvidenceVariable resource that defines the population for the research.
exposureVariant
  • A reference to a EvidenceVariable resource that defines the exposure for the research.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this evidence when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the evidence is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the evidence. This name should be usable as an identifier for the module by machine processing applications such as code generation.
note
  • A human-readable string to clarify or explain concepts about the resource.
outcome
  • A reference to a EvidenceVariable resomece that defines the outcome for the research.
publisher
  • The name of the organization or individual that published the evidence.
relatedArtifact
  • Related artifacts such as additional documentation, justification, or bibliographic references.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
shortTitle
  • The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
status
  • The status of this evidence. Enables tracking the life-cycle of the content.
subtitle
  • An explanatory or alternate title for the Evidence giving additional information about its content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the evidence.
topic
  • Descriptive topics related to the content of the Evidence. Topics provide a high-level categorization grouping types of Evidences that can be useful for filtering and searching.
url
  • An absolute URI that is used to identify this evidence when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this evidence is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence instances.
version
  • The identifier that is used to identify this version of the evidence when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
Constructor:

Introduces the fields url, name, date, note, title, topic, status, author, editor, version, contact, outcome, subtitle, reviewer, endorser, publisher, copyright, identifier, shortTitle, useContext, description, jurisdiction, approvalDate, lastReviewDate, effectivePeriod, relatedArtifact, exposureVariant, exposureBackground.

Companion:
object
object EvidenceVariable extends CompanionFor[EvidenceVariable]
Companion:
class
@POJOBoilerplate
class EvidenceVariable(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], val note: LitSeq[Annotation], `type`: Option[VARIABLE_TYPE], val title: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val version: Option[String], val contact: LitSeq[ContactDetail], val language: Option[LANGUAGES], val subtitle: Option[String], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val shortTitle: Option[String], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val modifierExtension: LitSeq[Extension], val characteristic: NonEmptyLitSeq[Characteristic], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The type of evidence element, a population, an exposure, or an outcome.
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
characteristic
  • A characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semantics.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the evidence variable and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence variable.
date
  • The date (and optionally time) when the evidence variable was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changes.
description
  • A free text natural language description of the evidence variable from a consumer's perspective.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectivePeriod
  • The period during which the evidence variable content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the evidence variable is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generation.
note
  • A human-readable string to clarify or explain concepts about the resource.
publisher
  • The name of the organization or individual that published the evidence variable.
relatedArtifact
  • Related artifacts such as additional documentation, justification, or bibliographic references.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
shortTitle
  • The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
status
  • The status of this evidence variable. Enables tracking the life-cycle of the content.
subtitle
  • An explanatory or alternate title for the EvidenceVariable giving additional information about its content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the evidence variable.
topic
  • Descriptive topics related to the content of the EvidenceVariable. Topics provide a high-level categorization grouping types of EvidenceVariables that can be useful for filtering and searching.
url
  • An absolute URI that is used to identify this evidence variable when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence variable instances.
version
  • The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
Constructor:

Introduces the fields url, name, date, note, type, title, topic, status, author, editor, version, contact, subtitle, reviewer, endorser, publisher, copyright, identifier, shortTitle, useContext, description, jurisdiction, approvalDate, lastReviewDate, effectivePeriod, relatedArtifact, characteristic.

Companion:
object
object ExampleScenario extends CompanionFor[ExampleScenario]
Companion:
class
@POJOBoilerplate
class ExampleScenario(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], val status: PUBLICATION_STATUS, val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val language: Option[LANGUAGES], val workflow: LitSeq[Canonical], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val actor: LitSeq[Actor], val process: LitSeq[Process], val instance: LitSeq[Instance], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Example of workflow instance.

Example of workflow instance.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
actor
  • Actor participating in the resource.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the example scenario and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the example scenario.
date
  • The date (and optionally time) when the example scenario was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the example scenario changes. (e.g. the 'content logical definition').
experimental
  • A Boolean value to indicate that this example scenario is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this example scenario when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
instance
  • Each resource and each version that is present in the workflow.
jurisdiction
  • A legal or geographic region in which the example scenario is intended to be used.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the example scenario. This name should be usable as an identifier for the module by machine processing applications such as code generation.
process
  • Each major process - a group of operations.
publisher
  • The name of the organization or individual that published the example scenario.
purpose
  • What the example scenario resource is created for. This should not be used to show the business purpose of the scenario itself, but the purpose of documenting a scenario.
status
  • The status of this example scenario. Enables tracking the life-cycle of the content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
url
  • An absolute URI that is used to identify this example scenario when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this example scenario is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the example scenario is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate example scenario instances.
version
  • The identifier that is used to identify this version of the example scenario when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the example scenario author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
workflow
  • Another nested workflow.
Constructor:

Introduces the fields url, name, date, status, version, contact, purpose, workflow, publisher, copyright, identifier, useContext, experimental, jurisdiction, actor, process, instance.

Companion:
object
object ExplanationOfBenefit extends CompanionFor[ExplanationOfBenefit]
Companion:
class
@POJOBoilerplate
class ExplanationOfBenefit(val id: Option[String], val use: CLAIM_USE, val meta: Option[Meta], val text: Option[Narrative], `type`: CodeableConcept, val form: Option[Attachment], val claim: Option[Reference], val status: EXPLANATIONOFBENEFIT_STATUS, val subType: Option[CodeableConcept], val patient: Reference, val created: FHIRDateTime, val enterer: Option[Reference], val insurer: Reference, val outcome: REMITTANCE_OUTCOME, val language: Option[LANGUAGES], val provider: Reference, val priority: Option[CodeableConcept], val referral: Option[Reference], val facility: Option[Reference], val formCode: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val preAuthRef: LitSeq[String], val precedence: Option[PositiveInt], val disposition: Option[String], val fundsReserve: Option[CodeableConcept], val prescription: Option[Reference], val adjudication: LitSeq[Adjudication], val implicitRules: Option[UriStr], val claimResponse: Option[Reference], val benefitPeriod: Option[Period], val billablePeriod: Option[Period], val preAuthRefPeriod: LitSeq[Period], val modifierExtension: LitSeq[Extension], val originalPrescription: Option[Reference], val fundsReserveRequested: Option[CodeableConcept], val payee: Option[Payee], val total: LitSeq[Total], val related: LitSeq[Related], val payment: Option[Payment], val careTeam: LitSeq[CareTeam], val accident: Option[Accident], val diagnosis: LitSeq[Diagnosis], val procedure: LitSeq[Procedure], val insurance: NonEmptyLitSeq[Insurance], val processNote: LitSeq[ProcessNote], val supportingInfo: LitSeq[SupportingInfo], val item: LitSeq[Item], val addItem: LitSeq[AddItem], val benefitBalance: LitSeq[BenefitBalance], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.

This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The category of claim, e.g. oral, pharmacy, vision, institutional, professional.
accident
  • Details of a accident which resulted in injuries which required the products and services listed in the claim.
addItem
  • The first-tier service adjudications for payor added product or service lines.
adjudication
  • The adjudication results which are presented at the header level rather than at the line-item or add-item levels.
benefitBalance
  • Balance by Benefit Category.
benefitPeriod
  • The term of the benefits documented in this response.
billablePeriod
  • The period for which charges are being submitted.
careTeam
  • The members of the team who provided the products and services.
claim
  • The business identifier for the instance of the adjudication request: claim predetermination or preauthorization.
claimResponse
  • The business identifier for the instance of the adjudication response: claim, predetermination or preauthorization response.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
created
  • The date this resource was created.
diagnosis
  • Information about diagnoses relevant to the claim items.
disposition
  • A human readable description of the status of the adjudication.
enterer
  • Individual who created the claim, predetermination or preauthorization.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
facility
  • Facility where the services were provided.
form
  • The actual form, by reference or inclusion, for printing the content or an EOB.
formCode
  • A code for the form to be used for printing the content.
fundsReserve
  • A code, used only on a response to a preauthorization, to indicate whether the benefits payable have been reserved and for whom.
fundsReserveRequested
  • A code to indicate whether and for whom funds are to be reserved for future claims.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this explanation of benefit.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
insurance
  • Financial instruments for reimbursement for the health care products and services specified on the claim.
insurer
  • The party responsible for authorization, adjudication and reimbursement.
item
  • A claim line. Either a simple (a product or service) or a 'group' of details which can also be a simple items or groups of sub-details.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
originalPrescription
  • Original prescription which has been superseded by this prescription to support the dispensing of pharmacy services, medications or products.
outcome
  • The outcome of the claim, predetermination, or preauthorization processing.
patient
  • The party to whom the professional services and/or products have been supplied or are being considered and for whom actual for forecast reimbursement is sought.
payee
  • The party to be reimbursed for cost of the products and services according to the terms of the policy.
payment
  • Payment details for the adjudication of the claim.
preAuthRef
  • Reference from the Insurer which is used in later communications which refers to this adjudication.
preAuthRefPeriod
  • The timeframe during which the supplied preauthorization reference may be quoted on claims to obtain the adjudication as provided.
precedence
  • This indicates the relative order of a series of EOBs related to different coverages for the same suite of services.
prescription
  • Prescription to support the dispensing of pharmacy, device or vision products.
priority
  • The provider-required urgency of processing the request. Typical values include: stat, routine deferred.
procedure
  • Procedures performed on the patient relevant to the billing items with the claim.
processNote
  • A note that describes or explains adjudication results in a human readable form.
provider
  • The provider which is responsible for the claim, predetermination or preauthorization.
referral
  • A reference to a referral resource.
related
  • Other claims which are related to this claim such as prior submissions or claims for related services or for the same event.
status
  • The status of the resource instance.
subType
  • A finer grained suite of claim type codes which may convey additional information such as Inpatient vs Outpatient and/or a specialty service.
supportingInfo
  • Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
total
  • Categorized monetary totals for the adjudication.
use
  • A code to indicate whether the nature of the request is: to request adjudication of products and services previously rendered; or requesting authorization and adjudication for provision in the future; or requesting the non-binding adjudication of the listed products and services which could be provided in the future.
Constructor:

Introduces the fields use, type, form, claim, status, subType, patient, created, enterer, insurer, outcome, provider, priority, referral, facility, formCode, identifier, preAuthRef, precedence, disposition, fundsReserve, prescription, adjudication, claimResponse, benefitPeriod, billablePeriod, preAuthRefPeriod, originalPrescription, fundsReserveRequested, payee, total, related, payment, careTeam, accident, diagnosis, procedure, insurance, processNote, supportingInfo, item, addItem, benefitBalance.

Companion:
object
object FHIRList extends CompanionFor[FHIRList]
Companion:
class
@POJOBoilerplate
class FHIRList(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val mode: LIST_MODE, val code: Option[CodeableConcept], val date: Option[FHIRDateTime], val note: LitSeq[Annotation], val title: Option[String], val status: LIST_STATUS, val source: Option[Reference], val subject: Option[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val orderedBy: Option[CodeableConcept], val identifier: LitSeq[Identifier], val emptyReason: Option[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val entry: LitSeq[Entry], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A list is a curated collection of resources.

A list is a curated collection of resources.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
code
  • This code defines the purpose of the list - why it was created.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
date
  • The date that the list was prepared.
emptyReason
  • If the list is empty, why the list is empty.
encounter
  • The encounter that is the context in which this list was created.
entry
  • Entries in this list.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifier for the List assigned for business purposes outside the context of FHIR.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
mode
  • How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Comments that apply to the overall list.
orderedBy
  • What order applies to the items in the list.
source
  • The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.
status
  • Indicates the current state of this list.
subject
  • The common subject (or patient) of the resources that are in the list if there is one.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A label for the list assigned by the author.
Constructor:

Introduces the fields mode, code, date, note, title, status, source, subject, encounter, orderedBy, identifier, emptyReason, entry.

Companion:
object
object FamilyMemberHistory extends CompanionFor[FamilyMemberHistory]
Companion:
class
@POJOBoilerplate
class FamilyMemberHistory(val id: Option[String], val sex: Option[CodeableConcept], val meta: Option[Meta], val text: Option[Narrative], val date: Option[FHIRDateTime], val name: Option[String], val note: LitSeq[Annotation], val status: HISTORY_STATUS, val age: Option[AgeChoice], val patient: Reference, val born: Option[BornChoice], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val deceased: Option[DeceasedChoice], val relationship: CodeableConcept, val estimatedAge: Option[Boolean], val implicitRules: Option[UriStr], val instantiatesUri: LitSeq[UriStr], val reasonReference: LitSeq[Reference], val dataAbsentReason: Option[CodeableConcept], val modifierExtension: LitSeq[Extension], val instantiatesCanonical: LitSeq[Canonical], val condition: LitSeq[Condition], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Significant health conditions for a person related to the patient relevant in the context of care for the patient.

Significant health conditions for a person related to the patient relevant in the context of care for the patient.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
age
  • The age of the relative at the time the family member history is recorded.
born
  • The actual or approximate date of birth of the relative.
condition
  • The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
dataAbsentReason
  • Describes why the family member's history is not available.
date
  • The date (and possibly time) when the family member history was recorded or last updated.
deceased
  • Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
estimatedAge
  • If true, indicates that the age value specified is an estimated value.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
instantiatesCanonical
  • The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
instantiatesUri
  • The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
note
  • This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.
patient
  • The person who this history concerns.
reasonCode
  • Describes why the family member history occurred in coded or textual form.
reasonReference
  • Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
relationship
  • The type of relationship this person has to the patient (father, mother, brother etc.).
sex
  • The birth sex of the family member.
status
  • A code specifying the status of the record of the family history of a specific family member.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields sex, date, name, note, status, age, patient, born, identifier, reasonCode, deceased, relationship, estimatedAge, instantiatesUri, reasonReference, dataAbsentReason, instantiatesCanonical, condition.

Companion:
object
object Flag extends CompanionFor[Flag]
Companion:
class
@POJOBoilerplate
class Flag(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: CodeableConcept, val status: FLAG_STATUS, val period: Option[Period], val author: Option[Reference], val subject: Reference, val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Prospective warnings of potential issues when providing care to the patient.

Prospective warnings of potential issues when providing care to the patient.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
author
  • The person, organization or device that created the flag.
category
  • Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.
code
  • The coded value or textual component of the flag to display to the user.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
encounter
  • This alert is only relevant during the encounter.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
period
  • The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.
status
  • Supports basic workflow.
subject
  • The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, status, period, author, subject, category, encounter, identifier.

Companion:
object
object Goal extends CompanionFor[Goal]
Companion:
class
@POJOBoilerplate
class Goal(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val note: LitSeq[Annotation], val subject: Reference, val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val priority: Option[CodeableConcept], val start: Option[StartChoice], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val addresses: LitSeq[Reference], val identifier: LitSeq[Identifier], val statusDate: Option[FHIRDate], val description: CodeableConcept, val expressedBy: Option[Reference], val outcomeCode: LitSeq[CodeableConcept], val statusReason: Option[String], val implicitRules: Option[UriStr], val lifecycleStatus: GOAL_STATUS, val outcomeReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val achievementStatus: Option[CodeableConcept], val target: LitSeq[Target], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
achievementStatus
  • Describes the progression, or lack thereof, towards the goal against the target.
addresses
  • The identified conditions and other health record elements that are intended to be addressed by the goal.
category
  • Indicates a category the goal falls within.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
description
  • Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
expressedBy
  • Indicates whose goal this is - patient goal, practitioner goal, etc.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
lifecycleStatus
  • The state of the goal throughout its lifecycle.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Any comments related to the goal.
outcomeCode
  • Identifies the change (or lack of change) at the point when the status of the goal is assessed.
outcomeReference
  • Details of what's changed (or not changed).
priority
  • Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
start
  • The date or event after which the goal should begin being pursued.
statusDate
  • Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
statusReason
  • Captures the reason for the current status.
subject
  • Identifies the patient, group or organization for whom the goal is being established.
target
  • Indicates what should be done by when.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields note, subject, category, priority, start, addresses, identifier, statusDate, description, expressedBy, outcomeCode, statusReason, lifecycleStatus, outcomeReference, achievementStatus, target.

Companion:
object
object GraphDefinition extends CompanionFor[GraphDefinition]
Companion:
class
@POJOBoilerplate
class GraphDefinition(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: String, val date: Option[FHIRDateTime], val start: RESOURCE_TYPES, val status: PUBLICATION_STATUS, val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val profile: Option[Canonical], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val link: LitSeq[Link], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.

A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
date
  • The date (and optionally time) when the graph definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the graph definition changes.
description
  • A free text natural language description of the graph definition from a consumer's perspective.
experimental
  • A Boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the graph definition is intended to be used.
language
  • The base language in which the resource is written.
link
  • Links this graph makes rules about.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
profile
  • The profile that describes the use of the base resource.
publisher
  • The name of the organization or individual that published the graph definition.
purpose
  • Explanation of why this graph definition is needed and why it has been designed as it has.
start
  • The type of FHIR resource at which instances of this graph start.
status
  • The status of this graph definition. Enables tracking the life-cycle of the content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
url
  • An absolute URI that is used to identify this graph definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this graph definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the graph definition is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate graph definition instances.
version
  • The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, start, status, version, contact, purpose, profile, publisher, useContext, description, experimental, jurisdiction, link.

Companion:
object
object Group extends CompanionFor[Group]
Companion:
class
@POJOBoilerplate
class Group(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: GROUP_TYPE, val code: Option[CodeableConcept], val name: Option[String], val active: Option[Boolean], val actual: Boolean, val language: Option[LANGUAGES], val quantity: Option[UnsignedInt], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val implicitRules: Option[UriStr], val managingEntity: Option[Reference], val modifierExtension: LitSeq[Extension], val member: LitSeq[Member], val characteristic: LitSeq[Characteristic], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.

Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Identifies the broad classification of the kind of resources the group includes.
active
  • Indicates whether the record for the group is available for use or is merely being retained for historical purposes.
actual
  • If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
characteristic
  • Identifies traits whose presence r absence is shared by members of the group.
code
  • Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique business identifier for this group.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
managingEntity
  • Entity responsible for defining and maintaining Group characteristics and/or registered members.
member
  • Identifies the resource instances that are members of the group.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A label assigned to the group for human identification and communication.
quantity
  • A count of the number of resource instances that are part of the group.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, code, name, active, actual, quantity, identifier, managingEntity, member, characteristic.

Companion:
object
object GuidanceResponse extends CompanionFor[GuidanceResponse]
Companion:
class
@POJOBoilerplate
class GuidanceResponse(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val note: LitSeq[Annotation], val status: GUIDANCE_RESPONSE_STATUS, val result: Option[Reference], val subject: Option[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val module: ModuleChoice, val encounter: Option[Reference], val performer: Option[Reference], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val reasonReference: LitSeq[Reference], val dataRequirement: LitSeq[DataRequirement], val outputParameters: Option[Reference], val modifierExtension: LitSeq[Extension], val requestIdentifier: Option[Identifier], val evaluationMessage: LitSeq[Reference], val occurrenceDateTime: Option[FHIRDateTime], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

A guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
dataRequirement
  • If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.
encounter
  • The encounter during which this response was created or to which the creation of this record is tightly associated.
evaluationMessage
  • Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Allows a service to provide unique, business identifiers for the response.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
module
  • An identifier, CodeableConcept or canonical reference to the guidance that was requested.
note
  • Provides a mechanism to communicate additional information about the response.
occurrenceDateTime
  • Indicates when the guidance response was processed.
outputParameters
  • The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.
performer
  • Provides a reference to the device that performed the guidance.
reasonCode
  • Describes the reason for the guidance response in coded or textual form.
reasonReference
  • Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
requestIdentifier
  • The identifier of the request associated with this response. If an identifier was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.
result
  • The actions, if any, produced by the evaluation of the artifact.
status
  • The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.
subject
  • The patient for which the request was processed.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields note, status, result, subject, module, encounter, performer, identifier, reasonCode, reasonReference, dataRequirement, outputParameters, requestIdentifier, evaluationMessage, occurrenceDateTime.

Companion:
object
object HealthcareService extends CompanionFor[HealthcareService]
Companion:
class
@POJOBoilerplate
class HealthcareService(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: LitSeq[CodeableConcept], val name: Option[String], val photo: Option[Attachment], val active: Option[Boolean], val comment: Option[String], val telecom: LitSeq[ContactPoint], val program: LitSeq[CodeableConcept], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val location: LitSeq[Reference], val endpoint: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val specialty: LitSeq[CodeableConcept], val identifier: LitSeq[Identifier], val providedBy: Option[Reference], val extraDetails: Option[Markdown], val coverageArea: LitSeq[Reference], val implicitRules: Option[UriStr], val communication: LitSeq[CodeableConcept], val characteristic: LitSeq[CodeableConcept], val referralMethod: LitSeq[CodeableConcept], val modifierExtension: LitSeq[Extension], val appointmentRequired: Option[Boolean], val serviceProvisionCode: LitSeq[CodeableConcept], val availabilityExceptions: Option[String], val eligibility: LitSeq[Eligibility], val notAvailable: LitSeq[NotAvailable], val availableTime: LitSeq[AvailableTime], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The details of a healthcare service available at a location.

The details of a healthcare service available at a location.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The specific type of service that may be delivered or performed.
active
  • This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.
appointmentRequired
  • Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
availabilityExceptions
  • A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
availableTime
  • A collection of times that the Service Site is available.
category
  • Identifies the broad category of service being performed or delivered.
characteristic
  • Collection of characteristics (attributes).
comment
  • Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
communication
  • Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
coverageArea
  • The location(s) that this service is available to (not where the service is provided).
eligibility
  • Does this service have specific eligibility requirements that need to be met in order to use the service?
endpoint
  • Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
extraDetails
  • Extra details about the service that can't be placed in the other fields.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • External identifiers for this item.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
location
  • The location(s) where this healthcare service may be provided.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • Further description of the service as it would be presented to a consumer while searching.
notAvailable
  • The HealthcareService is not available during this period of time due to the provided reason.
photo
  • If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
program
  • Programs that this service is applicable to.
providedBy
  • The organization that provides this healthcare service.
referralMethod
  • Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
serviceProvisionCode
  • The code(s) that detail the conditions under which the healthcare service is available/offered.
specialty
  • Collection of specialties handled by the service site. This is more of a medical term.
telecom
  • List of contacts related to this specific healthcare service.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, name, photo, active, comment, telecom, program, category, location, endpoint, specialty, identifier, providedBy, extraDetails, coverageArea, communication, characteristic, referralMethod, appointmentRequired, serviceProvisionCode, availabilityExceptions, eligibility, notAvailable, availableTime.

Companion:
object
object ImagingStudy extends CompanionFor[ImagingStudy]
Companion:
class
@POJOBoilerplate
class ImagingStudy(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val note: LitSeq[Annotation], val status: IMAGINGSTUDY_STATUS, val subject: Reference, val started: Option[FHIRDateTime], val basedOn: LitSeq[Reference], val language: Option[LANGUAGES], val modality: LitSeq[Coding], val referrer: Option[Reference], val endpoint: LitSeq[Reference], val location: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val interpreter: LitSeq[Reference], val description: Option[String], val implicitRules: Option[UriStr], val procedureCode: LitSeq[CodeableConcept], val numberOfSeries: Option[UnsignedInt], val reasonReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val numberOfInstances: Option[UnsignedInt], val procedureReference: Option[Reference], val series: LitSeq[Series], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
basedOn
  • A list of the diagnostic requests that resulted in this imaging study being performed.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
description
  • The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.
encounter
  • The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.
endpoint
  • The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
interpreter
  • Who read the study and interpreted the images or other content.
language
  • The base language in which the resource is written.
location
  • The principal physical location where the ImagingStudy was performed.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modality
  • A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.
numberOfInstances
  • Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
numberOfSeries
  • Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
procedureCode
  • The code for the performed procedure type.
procedureReference
  • The procedure which this ImagingStudy was part of.
reasonCode
  • Description of clinical condition indicating why the ImagingStudy was requested.
reasonReference
  • Indicates another resource whose existence justifies this Study.
referrer
  • The requesting/referring physician.
series
  • Each study has one or more series of images or other content.
started
  • Date and time the study started.
status
  • The current state of the ImagingStudy.
subject
  • The subject, typically a patient, of the imaging study.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields note, status, subject, started, basedOn, modality, referrer, endpoint, location, encounter, identifier, reasonCode, interpreter, description, procedureCode, numberOfSeries, reasonReference, numberOfInstances, procedureReference, series.

Companion:
object
object Immunization extends CompanionFor[Immunization]
Companion:
class
@POJOBoilerplate
class Immunization(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val site: Option[CodeableConcept], val note: LitSeq[Annotation], val route: Option[CodeableConcept], val status: IMMUNIZATION_STATUS, val patient: Reference, val language: Option[LANGUAGES], val recorded: Option[FHIRDateTime], val location: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val lotNumber: Option[String], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val vaccineCode: CodeableConcept, val isSubpotent: Option[Boolean], val statusReason: Option[CodeableConcept], val reportOrigin: Option[CodeableConcept], val manufacturer: Option[Reference], val doseQuantity: Option[Quantity], val implicitRules: Option[UriStr], val occurrence: OccurrenceChoice, val primarySource: Option[Boolean], val fundingSource: Option[CodeableConcept], val expirationDate: Option[FHIRDate], val reasonReference: LitSeq[Reference], val subpotentReason: LitSeq[CodeableConcept], val modifierExtension: LitSeq[Extension], val programEligibility: LitSeq[CodeableConcept], val reaction: LitSeq[Reaction], val performer: LitSeq[Performer], val education: LitSeq[Education], val protocolApplied: LitSeq[ProtocolApplied], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
doseQuantity
  • The quantity of vaccine product that was administered.
education
  • Educational material presented to the patient (or guardian) at the time of vaccine administration.
encounter
  • The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
expirationDate
  • Date vaccine batch expires.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
fundingSource
  • Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this immunization record.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
isSubpotent
  • Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
language
  • The base language in which the resource is written.
location
  • The service delivery location where the vaccine administration occurred.
lotNumber
  • Lot number of the vaccine product.
manufacturer
  • Name of vaccine manufacturer.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Extra information about the immunization that is not conveyed by the other attributes.
occurrence
  • Date vaccine administered or was to be administered.
patient
  • The patient who either received or did not receive the immunization.
performer
  • Indicates who performed the immunization event.
primarySource
  • An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
programEligibility
  • Indicates a patient's eligibility for a funding program.
protocolApplied
  • The protocol (set of recommendations) being followed by the provider who administered the dose.
reaction
  • Categorical data indicating that an adverse event is associated in time to an immunization.
reasonCode
  • Reasons why the vaccine was administered.
reasonReference
  • Condition, Observation or DiagnosticReport that supports why the immunization was administered.
recorded
  • The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
reportOrigin
  • The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
route
  • The path by which the vaccine product is taken into the body.
site
  • Body site where vaccine was administered.
status
  • Indicates the current status of the immunization event.
statusReason
  • Indicates the reason the immunization event was not performed.
subpotentReason
  • Reason why a dose is considered to be subpotent.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
vaccineCode
  • Vaccine that was administered or was to be administered.
Constructor:

Introduces the fields site, note, route, status, patient, recorded, location, encounter, lotNumber, identifier, reasonCode, vaccineCode, isSubpotent, statusReason, reportOrigin, manufacturer, doseQuantity, occurrence, primarySource, fundingSource, expirationDate, reasonReference, subpotentReason, programEligibility, reaction, performer, education, protocolApplied.

Companion:
object
object ImmunizationEvaluation extends CompanionFor[ImmunizationEvaluation]
Companion:
class
@POJOBoilerplate
class ImmunizationEvaluation(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val date: Option[FHIRDateTime], val status: IMMUNIZATION_EVALUATION_STATUS, val series: Option[String], val patient: Reference, val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val authority: Option[Reference], val identifier: LitSeq[Identifier], val doseStatus: CodeableConcept, val description: Option[String], val implicitRules: Option[UriStr], val targetDisease: CodeableConcept, val doseNumber: Option[DoseNumberChoice], val seriesDoses: Option[SeriesDosesChoice], val doseStatusReason: LitSeq[CodeableConcept], val modifierExtension: LitSeq[Extension], val immunizationEvent: Reference, val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.

Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
authority
  • Indicates the authority who published the protocol (e.g. ACIP).
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
date
  • The date the evaluation of the vaccine administration event was performed.
description
  • Additional information about the evaluation.
doseNumber
  • Nominal position in a series.
doseStatus
  • Indicates if the dose is valid or not valid with respect to the published recommendations.
doseStatusReason
  • Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this immunization evaluation record.
immunizationEvent
  • The vaccine administration event being evaluated.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
patient
  • The individual for whom the evaluation is being done.
series
  • One possible path to achieve presumed immunity against a disease - within the context of an authority.
seriesDoses
  • The recommended number of doses to achieve immunity.
status
  • Indicates the current status of the evaluation of the vaccination administration event.
targetDisease
  • The vaccine preventable disease the dose is being evaluated against.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields date, status, series, patient, authority, identifier, doseStatus, description, targetDisease, doseNumber, seriesDoses, doseStatusReason, immunizationEvent.

Companion:
object
Companion:
class
@POJOBoilerplate
class ImmunizationRecommendation(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val date: FHIRDateTime, val patient: Reference, val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val authority: Option[Reference], val identifier: LitSeq[Identifier], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val recommendation: NonEmptyLitSeq[Recommendation], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
authority
  • Indicates the authority who published the protocol (e.g. ACIP).
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
date
  • The date the immunization recommendation(s) were created.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this particular recommendation record.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
patient
  • The patient the recommendation(s) are for.
recommendation
  • Vaccine administration recommendations.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields date, patient, authority, identifier, recommendation.

Companion:
object
object ImplementationGuide extends CompanionFor[ImplementationGuide]
Companion:
class
@POJOBoilerplate
class ImplementationGuide(val id: Option[String], val url: UriStr, val meta: Option[Meta], val text: Option[Narrative], val name: String, val date: Option[FHIRDateTime], val title: Option[String], val status: PUBLICATION_STATUS, val version: Option[String], val contact: LitSeq[ContactDetail], val license: Option[SPDX_LICENSE], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val packageId: Id, val useContext: LitSeq[UsageContext], val description: Option[Markdown], val fhirVersion: NonEmptyLitSeq[FHIR_VERSION], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val global: LitSeq[Global], val dependsOn: LitSeq[DependsOn], val manifest: Option[Manifest], val definition: Option[Definition], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.

A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.
date
  • The date (and optionally time) when the implementation guide was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.
definition
  • The information needed by an IG publisher tool to publish the whole implementation guide.
dependsOn
  • Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
description
  • A free text natural language description of the implementation guide from a consumer's perspective.
experimental
  • A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
fhirVersion
  • The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.
global
  • A set of profiles that all resources covered by this implementation guide must conform to.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the implementation guide is intended to be used.
language
  • The base language in which the resource is written.
license
  • The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.
manifest
  • Information about an assembled implementation guide, created by the publication tooling.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.
packageId
  • The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.
publisher
  • The name of the organization or individual that published the implementation guide.
status
  • The status of this implementation guide. Enables tracking the life-cycle of the content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the implementation guide.
url
  • An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate implementation guide instances.
version
  • The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, title, status, version, contact, license, publisher, copyright, packageId, useContext, description, fhirVersion, experimental, jurisdiction, global, dependsOn, manifest, definition.

Companion:
object
object InsurancePlan extends CompanionFor[InsurancePlan]
Companion:
class
@POJOBoilerplate
class InsurancePlan(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: LitSeq[CodeableConcept], val name: Option[String], val alias: LitSeq[String], val status: Option[PUBLICATION_STATUS], val period: Option[Period], val ownedBy: Option[Reference], val network: LitSeq[Reference], val language: Option[LANGUAGES], val endpoint: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val coverageArea: LitSeq[Reference], val implicitRules: Option[UriStr], val administeredBy: Option[Reference], val modifierExtension: LitSeq[Extension], val contact: LitSeq[Contact], val coverage: LitSeq[Coverage], val plan: LitSeq[Plan], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Details of a Health Insurance product/plan provided by an organization.

Details of a Health Insurance product/plan provided by an organization.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The kind of health insurance product.
administeredBy
  • An organization which administer other services such as underwriting, customer service and/or claims processing on behalf of the health insurance product owner.
alias
  • A list of alternate names that the product is known as, or was known as in the past.
contact
  • The contact for the health insurance product for a certain purpose.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
coverage
  • Details about the coverage offered by the insurance product.
coverageArea
  • The geographic region in which a health insurance product's benefits apply.
endpoint
  • The technical endpoints providing access to services operated for the health insurance product.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this health insurance product which remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • Official name of the health insurance product as designated by the owner.
network
  • Reference to the network included in the health insurance product.
ownedBy
  • The entity that is providing the health insurance product and underwriting the risk. This is typically an insurance carriers, other third-party payers, or health plan sponsors comonly referred to as 'payers'.
period
  • The period of time that the health insurance product is available.
plan
  • Details about an insurance plan.
status
  • The current state of the health insurance product.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, name, alias, status, period, ownedBy, network, endpoint, identifier, coverageArea, administeredBy, contact, coverage, plan.

Companion:
object
object Invoice extends CompanionFor[Invoice]
Companion:
class
@POJOBoilerplate
class Invoice(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val date: Option[FHIRDateTime], val note: LitSeq[Annotation], val status: INVOICE_STATUS, val issuer: Option[Reference], val subject: Option[Reference], val account: Option[Reference], val language: Option[LANGUAGES], val totalNet: Option[Money], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val recipient: Option[Reference], val identifier: LitSeq[Identifier], val totalGross: Option[Money], val paymentTerms: Option[Markdown], val implicitRules: Option[UriStr], val cancelledReason: Option[String], val modifierExtension: LitSeq[Extension], val totalPriceComponent: LitSeq[PriceComponent], val participant: LitSeq[Participant], val lineItem: LitSeq[LineItem], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary).
account
  • Account which is supposed to be balanced with this Invoice.
cancelledReason
  • In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
date
  • Date/time(s) of when this Invoice was posted.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
issuer
  • The organizationissuing the Invoice.
language
  • The base language in which the resource is written.
lineItem
  • Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Comments made about the invoice by the issuer, subject, or other participants.
participant
  • Indicates who or what performed or participated in the charged service.
paymentTerms
  • Payment details such as banking details, period of payment, deductibles, methods of payment.
recipient
  • The individual or Organization responsible for balancing of this invoice.
status
  • The current state of the Invoice.
subject
  • The individual or set of individuals receiving the goods and services billed in this invoice.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
totalGross
  • Invoice total, tax included.
totalNet
  • Invoice total , taxes excluded.
totalPriceComponent
  • The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated.
Constructor:

Introduces the fields type, date, note, status, issuer, subject, account, totalNet, recipient, identifier, totalGross, paymentTerms, cancelledReason, totalPriceComponent, participant, lineItem.

Companion:
object
object Library extends CompanionFor[Library]
Companion:
class
@POJOBoilerplate
class Library(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], `type`: CodeableConcept, val date: Option[FHIRDateTime], val title: Option[String], val usage: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val content: LitSeq[Attachment], val language: Option[LANGUAGES], val subtitle: Option[String], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val parameter: LitSeq[ParameterDefinition], val identifier: LitSeq[Identifier], val subject: Option[SubjectChoice], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val dataRequirement: LitSeq[DataRequirement], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.

The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
content
  • The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.
copyright
  • A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.
dataRequirement
  • Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.
date
  • The date (and optionally time) when the library was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.
description
  • A free text natural language description of the library from a consumer's perspective.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectivePeriod
  • The period during which the library content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
experimental
  • A Boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the library is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.
parameter
  • The parameter element defines parameters used by the library.
publisher
  • The name of the organization or individual that published the library.
purpose
  • Explanation of why this library is needed and why it has been designed as it has.
relatedArtifact
  • Related artifacts such as additional documentation, justification, or bibliographic references.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
status
  • The status of this library. Enables tracking the life-cycle of the content.
subject
  • A code or group definition that describes the intended subject of the contents of the library.
subtitle
  • An explanatory or alternate title for the library giving additional information about its content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the library.
topic
  • Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.
url
  • An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.
usage
  • A detailed description of how the library is used from a clinical perspective.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.
version
  • The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
Constructor:

Introduces the fields url, name, type, date, title, usage, topic, status, author, editor, version, contact, purpose, content, subtitle, reviewer, endorser, publisher, copyright, parameter, identifier, subject, useContext, description, experimental, jurisdiction, approvalDate, lastReviewDate, effectivePeriod, relatedArtifact, dataRequirement.

Companion:
object
object Linkage extends CompanionFor[Linkage]
Companion:
class
@POJOBoilerplate
class Linkage(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val active: Option[Boolean], val author: Option[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val item: NonEmptyLitSeq[Item], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Identifies two or more records (resource instances) that refer to the same real-world "occurrence".

Identifies two or more records (resource instances) that refer to the same real-world "occurrence".

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
active
  • Indicates whether the asserted set of linkages are considered to be "in effect".
author
  • Identifies the user or organization responsible for asserting the linkages as well as the user or organization who establishes the context in which the nature of each linkage is evaluated.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
item
  • Identifies which record considered as the reference to the same real-world occurrence as well as how the items should be evaluated within the collection of linked items.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields active, author, item.

Companion:
object
object Location extends CompanionFor[Location]
Companion:
class
@POJOBoilerplate
class Location(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val mode: Option[LOCATION_MODE], `type`: LitSeq[CodeableConcept], val alias: LitSeq[String], val status: Option[LOCATION_STATUS], val partOf: Option[Reference], val telecom: LitSeq[ContactPoint], val address: Option[Address], val language: Option[LANGUAGES], val endpoint: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val description: Option[String], val physicalType: Option[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val operationalStatus: Option[Coding], val managingOrganization: Option[Reference], val availabilityExceptions: Option[String], val position: Option[Position], val hoursOfOperation: LitSeq[HoursOfOperation], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Indicates the type of function performed at the location.
address
  • Physical location.
alias
  • A list of alternate names that the location is known as, or was known as, in the past.
availabilityExceptions
  • A description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
description
  • Description of the Location, which helps in finding or referencing the place.
endpoint
  • Technical endpoints providing access to services operated for the location.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
hoursOfOperation
  • What days/times during a week is this location usually open.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Unique code or number identifying the location to its users.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
managingOrganization
  • The organization responsible for the provisioning and upkeep of the location.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
mode
  • Indicates whether a resource instance represents a specific location or a class of locations.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • Name of the location as used by humans. Does not need to be unique.
operationalStatus
  • The operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
partOf
  • Another Location of which this Location is physically a part of.
physicalType
  • Physical form of the location, e.g. building, room, vehicle, road.
position
  • The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
status
  • The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
telecom
  • The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields name, mode, type, alias, status, partOf, telecom, address, endpoint, identifier, description, physicalType, operationalStatus, managingOrganization, availabilityExceptions, position, hoursOfOperation.

Companion:
object
object Measure extends CompanionFor[Measure]
Companion:
class
@POJOBoilerplate
class Measure(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], `type`: LitSeq[CodeableConcept], val title: Option[String], val usage: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val library: LitSeq[Canonical], val scoring: Option[CodeableConcept], val language: Option[LANGUAGES], val subtitle: Option[String], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val guidance: Option[Markdown], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val rationale: Option[Markdown], val identifier: LitSeq[Identifier], val subject: Option[SubjectChoice], val useContext: LitSeq[UsageContext], val disclaimer: Option[Markdown], val definition: LitSeq[Markdown], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val lastReviewDate: Option[FHIRDate], val riskAdjustment: Option[String], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val rateAggregation: Option[String], val compositeScoring: Option[CodeableConcept], val modifierExtension: LitSeq[Extension], val improvementNotation: Option[CodeableConcept], val clinicalRecommendationStatement: Option[Markdown], val supplementalData: LitSeq[SupplementalData], val group: LitSeq[Group], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The Measure resource provides the definition of a quality measure.

The Measure resource provides the definition of a quality measure.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
clinicalRecommendationStatement
  • Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
compositeScoring
  • If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
date
  • The date (and optionally time) when the measure was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.
definition
  • Provides a description of an individual term used within the measure.
description
  • A free text natural language description of the measure from a consumer's perspective.
disclaimer
  • Notices and disclaimers regarding the use of the measure or related to intellectual property (such as code systems) referenced by the measure.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectivePeriod
  • The period during which the measure content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
experimental
  • A Boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
group
  • A group of population criteria for the measure.
guidance
  • Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
improvementNotation
  • Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).
jurisdiction
  • A legal or geographic region in which the measure is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
library
  • A reference to a Library resource containing the formal logic used by the measure.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the measure.
purpose
  • Explanation of why this measure is needed and why it has been designed as it has.
rateAggregation
  • Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.
rationale
  • Provides a succinct statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
relatedArtifact
  • Related artifacts such as additional documentation, justification, or bibliographic references.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
riskAdjustment
  • A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.
scoring
  • Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.
status
  • The status of this measure. Enables tracking the life-cycle of the content.
subject
  • The intended subjects for the measure. If this element is not provided, a Patient subject is assumed, but the subject of the measure can be anything.
subtitle
  • An explanatory or alternate title for the measure giving additional information about its content.
supplementalData
  • The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the measure.
topic
  • Descriptive topics related to the content of the measure. Topics provide a high-level categorization grouping types of measures that can be useful for filtering and searching.
url
  • An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this measure is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the measure is stored on different servers.
usage
  • A detailed description, from a clinical perspective, of how the measure is used.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate measure instances.
version
  • The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
Constructor:

Introduces the fields url, name, date, type, title, usage, topic, status, author, editor, version, contact, purpose, library, scoring, subtitle, reviewer, endorser, guidance, publisher, copyright, rationale, identifier, subject, useContext, disclaimer, definition, description, experimental, jurisdiction, approvalDate, lastReviewDate, riskAdjustment, effectivePeriod, relatedArtifact, rateAggregation, compositeScoring, improvementNotation, clinicalRecommendationStatement, supplementalData, group.

Companion:
object
object MeasureReport extends CompanionFor[MeasureReport]
Companion:
class
@POJOBoilerplate
class MeasureReport(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: MEASURE_REPORT_TYPE, val date: Option[FHIRDateTime], val status: MEASURE_REPORT_STATUS, val period: Period, val measure: Canonical, val subject: Option[Reference], val language: Option[LANGUAGES], val reporter: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val evaluatedResource: LitSeq[Reference], val improvementNotation: Option[CodeableConcept], val group: LitSeq[Group], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.

The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
date
  • The date this measure report was generated.
evaluatedResource
  • A reference to a Bundle containing the Resources that were used in the calculation of this measure.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
group
  • The results of the calculation, one for each population group in the measure.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
improvementNotation
  • Whether improvement in the measure is noted by an increase or decrease in the measure score.
language
  • The base language in which the resource is written.
measure
  • A reference to the Measure that was calculated to produce this report.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
period
  • The reporting period for which the report was calculated.
reporter
  • The individual, location, or organization that is reporting the data.
status
  • The MeasureReport status. No data will be available until the MeasureReport status is complete.
subject
  • Optional subject identifying the individual or individuals the report is for.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, date, status, period, measure, subject, reporter, identifier, evaluatedResource, improvementNotation, group.

Companion:
object
object Media extends CompanionFor[Media]
Companion:
class
@POJOBoilerplate
class Media(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val view: Option[CodeableConcept], val note: LitSeq[Annotation], val width: Option[PositiveInt], val partOf: LitSeq[Reference], val status: EVENT_STATUS, val issued: Option[ZonedDateTime], val device: Option[Reference], val height: Option[PositiveInt], val frames: Option[PositiveInt], val basedOn: LitSeq[Reference], val subject: Option[Reference], val content: Attachment, val language: Option[LANGUAGES], val modality: Option[CodeableConcept], val operator: Option[Reference], val bodySite: Option[CodeableConcept], val duration: Option[BigDecimal], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val created: Option[CreatedChoice], val reasonCode: LitSeq[CodeableConcept], val deviceName: Option[String], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • A code that classifies whether the media is an image, video or audio recording or some other media category.
basedOn
  • A procedure that is fulfilled in whole or in part by the creation of this media.
bodySite
  • Indicates the site on the subject's body where the observation was made (i.e. the target site).
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
content
  • The actual content of the media - inline or by direct reference to the media source file.
created
  • The date and time(s) at which the media was collected.
device
  • The device used to collect the media.
deviceName
  • The name of the device / manufacturer of the device that was used to make the recording.
duration
  • The duration of the recording in seconds - for audio and video.
encounter
  • The encounter that establishes the context for this media.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
frames
  • The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
height
  • Height of the image in pixels (photo/video).
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
issued
  • The date and time this version of the media was made available to providers, typically after having been reviewed.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modality
  • Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Comments made about the media by the performer, subject or other participants.
operator
  • The person who administered the collection of the image.
partOf
  • A larger event of which this particular event is a component or step.
reasonCode
  • Describes why the event occurred in coded or textual form.
status
  • The current state of the {{title}}.
subject
  • Who/What this Media is a record of.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
view
  • The name of the imaging view e.g. Lateral or Antero-posterior (AP).
width
  • Width of the image in pixels (photo/video).
Constructor:

Introduces the fields type, view, note, width, partOf, status, issued, device, height, frames, basedOn, subject, content, modality, operator, bodySite, duration, encounter, identifier, created, reasonCode, deviceName.

Companion:
object
object Medication extends CompanionFor[Medication]
Companion:
class
@POJOBoilerplate
class Medication(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val form: Option[CodeableConcept], val status: Option[MEDICATION_STATUS], val amount: Option[Ratio], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val manufacturer: Option[Reference], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val batch: Option[Batch], val ingredient: LitSeq[Ingredient], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
amount
  • Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
batch
  • Information that only applies to packages (not products).
code
  • A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
form
  • Describes the form of the item. Powder; tablets; capsule.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifier for this medication.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
ingredient
  • Identifies a particular constituent of interest in the product.
language
  • The base language in which the resource is written.
manufacturer
  • Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
status
  • A code to indicate if the medication is in active use.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, form, status, amount, identifier, manufacturer, batch, ingredient.

Companion:
object
Companion:
class
@POJOBoilerplate
class MedicationAdministration(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val note: LitSeq[Annotation], val partOf: LitSeq[Reference], val status: MEDICATION_ADMIN_STATUS, val device: LitSeq[Reference], val subject: Reference, val context: Option[Reference], val request: Option[Reference], val language: Option[LANGUAGES], val category: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val instantiates: LitSeq[UriStr], val statusReason: LitSeq[CodeableConcept], val effective: EffectiveChoice, val eventHistory: LitSeq[Reference], val implicitRules: Option[UriStr], val medication: MedicationChoice, val reasonReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val supportingInformation: LitSeq[Reference], val dosage: Option[Dosage], val performer: LitSeq[Performer], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
category
  • Indicates where the medication is expected to be consumed or administered.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
context
  • The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
device
  • The device used in administering the medication to the patient. For example, a particular infusion pump.
dosage
  • Describes the medication dosage information details e.g. dose, rate, site, route, etc.
effective
  • A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
eventHistory
  • A summary of the events of interest that have occurred, such as when the administration was verified.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
instantiates
  • A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.
language
  • The base language in which the resource is written.
medication
  • Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Extra information about the medication administration that is not conveyed by the other attributes.
partOf
  • A larger event of which this particular event is a component or step.
performer
  • Indicates who or what performed the medication administration and how they were involved.
reasonCode
  • A code indicating why the medication was given.
reasonReference
  • Condition or observation that supports why the medication was administered.
request
  • The original request, instruction or authority to perform the administration.
status
  • Will generally be set to show that the administration has been completed. For some long running administrations such as infusions, it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
statusReason
  • A code indicating why the administration was not performed.
subject
  • The person or animal or group receiving the medication.
supportingInformation
  • Additional information (for example, patient height and weight) that supports the administration of the medication.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields note, partOf, status, device, subject, context, request, category, identifier, reasonCode, instantiates, statusReason, effective, eventHistory, medication, reasonReference, supportingInformation, dosage, performer.

Companion:
object
object MedicationDispense extends CompanionFor[MedicationDispense]
Companion:
class
@POJOBoilerplate
class MedicationDispense(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val note: LitSeq[Annotation], val partOf: LitSeq[Reference], val status: MEDICATIONDISPENSE_STATUS, val subject: Option[Reference], val context: Option[Reference], val language: Option[LANGUAGES], val category: Option[CodeableConcept], val location: Option[Reference], val quantity: Option[Quantity], val receiver: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val daysSupply: Option[Quantity], val destination: Option[Reference], val whenPrepared: Option[FHIRDateTime], val eventHistory: LitSeq[Reference], val implicitRules: Option[UriStr], val medication: MedicationChoice, val detectedIssue: LitSeq[Reference], val whenHandedOver: Option[FHIRDateTime], val statusReason: Option[StatusReasonChoice], val modifierExtension: LitSeq[Extension], val dosageInstruction: LitSeq[Dosage], val supportingInformation: LitSeq[Reference], val authorizingPrescription: LitSeq[Reference], val performer: LitSeq[Performer], val substitution: Option[Substitution], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
authorizingPrescription
  • Indicates the medication order that is being dispensed against.
category
  • Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
context
  • The encounter or episode of care that establishes the context for this event.
daysSupply
  • The amount of medication expressed as a timing amount.
destination
  • Identification of the facility/location where the medication was shipped to, as part of the dispense event.
detectedIssue
  • Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.
dosageInstruction
  • Indicates how the medication is to be used by the patient.
eventHistory
  • A summary of the events of interest that have occurred, such as when the dispense was verified.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
location
  • The principal physical location where the dispense was performed.
medication
  • Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Extra information about the dispense that could not be conveyed in the other attributes.
partOf
  • The procedure that trigger the dispense.
performer
  • Indicates who or what performed the event.
quantity
  • The amount of medication that has been dispensed. Includes unit of measure.
receiver
  • Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
status
  • A code specifying the state of the set of dispense events.
statusReason
  • Indicates the reason why a dispense was not performed.
subject
  • A link to a resource representing the person or the group to whom the medication will be given.
substitution
  • Indicates whether or not substitution was made as part of the dispense. In some cases, substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
supportingInformation
  • Additional information that supports the medication being dispensed.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
whenHandedOver
  • The time the dispensed product was provided to the patient or their representative.
whenPrepared
  • The time when the dispensed product was packaged and reviewed.
Constructor:

Introduces the fields type, note, partOf, status, subject, context, category, location, quantity, receiver, identifier, daysSupply, destination, whenPrepared, eventHistory, medication, detectedIssue, whenHandedOver, statusReason, dosageInstruction, supportingInformation, authorizingPrescription, performer, substitution.

Companion:
object
object MedicationKnowledge extends CompanionFor[MedicationKnowledge]
Companion:
class
@POJOBoilerplate
class MedicationKnowledge(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val status: Option[MEDICATIONKNOWLEDGE_STATUS], val amount: Option[Quantity], val synonym: LitSeq[String], val language: Option[LANGUAGES], val doseForm: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val productType: LitSeq[CodeableConcept], val manufacturer: Option[Reference], val implicitRules: Option[UriStr], val intendedRoute: LitSeq[CodeableConcept], val contraindication: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val associatedMedication: LitSeq[Reference], val preparationInstruction: Option[Markdown], val cost: LitSeq[Cost], val kinetics: LitSeq[Kinetics], val monograph: LitSeq[Monograph], val packaging: Option[Packaging], val ingredient: LitSeq[Ingredient], val monitoringProgram: LitSeq[MonitoringProgram], val drugCharacteristic: LitSeq[DrugCharacteristic], val medicineClassification: LitSeq[MedicineClassification], val regulatory: LitSeq[Regulatory], val relatedMedicationKnowledge: LitSeq[RelatedMedicationKnowledge], val administrationGuidelines: LitSeq[AdministrationGuidelines], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Information about a medication that is used to support knowledge.

Information about a medication that is used to support knowledge.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
administrationGuidelines
  • Guidelines for the administration of the medication.
amount
  • Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
associatedMedication
  • Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).
code
  • A code that specifies this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
contraindication
  • Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).
cost
  • The price of the medication.
doseForm
  • Describes the form of the item. Powder; tablets; capsule.
drugCharacteristic
  • Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
ingredient
  • Identifies a particular constituent of interest in the product.
intendedRoute
  • The intended or approved route of administration.
kinetics
  • The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.
language
  • The base language in which the resource is written.
manufacturer
  • Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
medicineClassification
  • Categorization of the medication within a formulary or classification system.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
monitoringProgram
  • The program under which the medication is reviewed.
monograph
  • Associated documentation about the medication.
packaging
  • Information that only applies to packages (not products).
preparationInstruction
  • The instructions for preparing the medication.
productType
  • Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).
regulatory
  • Regulatory information about a medication.
relatedMedicationKnowledge
  • Associated or related knowledge about a medication.
status
  • A code to indicate if the medication is in active use. The status refers to the validity about the information of the medication and not to its medicinal properties.
synonym
  • Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, status, amount, synonym, doseForm, productType, manufacturer, intendedRoute, contraindication, associatedMedication, preparationInstruction, cost, kinetics, monograph, packaging, ingredient, monitoringProgram, drugCharacteristic, medicineClassification, regulatory, relatedMedicationKnowledge, administrationGuidelines.

Companion:
object
object MedicationRequest extends CompanionFor[MedicationRequest]
Companion:
class
@POJOBoilerplate
class MedicationRequest(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val note: LitSeq[Annotation], val status: MEDICATIONREQUEST_STATUS, val intent: MEDICATIONREQUEST_INTENT, val subject: Reference, val basedOn: LitSeq[Reference], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val priority: Option[REQUEST_PRIORITY], val recorder: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val requester: Option[Reference], val performer: Option[Reference], val insurance: LitSeq[Reference], val identifier: LitSeq[Identifier], val authoredOn: Option[FHIRDateTime], val reasonCode: LitSeq[CodeableConcept], val reported: Option[ReportedChoice], val statusReason: Option[CodeableConcept], val doNotPerform: Option[Boolean], val eventHistory: LitSeq[Reference], val implicitRules: Option[UriStr], val medication: MedicationChoice, val performerType: Option[CodeableConcept], val detectedIssue: LitSeq[Reference], val reasonReference: LitSeq[Reference], val instantiatesUri: LitSeq[UriStr], val groupIdentifier: Option[Identifier], val modifierExtension: LitSeq[Extension], val dosageInstruction: LitSeq[Dosage], val priorPrescription: Option[Reference], val courseOfTherapyType: Option[CodeableConcept], val supportingInformation: LitSeq[Reference], val instantiatesCanonical: LitSeq[Canonical], val substitution: Option[Substitution], val dispenseRequest: Option[DispenseRequest], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
authoredOn
  • The date (and perhaps time) when the prescription was initially written or authored on.
basedOn
  • A plan or request that is fulfilled in whole or in part by this medication request.
category
  • Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
courseOfTherapyType
  • The description of the overall patte3rn of the administration of the medication to the patient.
detectedIssue
  • Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
dispenseRequest
  • Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
doNotPerform
  • If true indicates that the provider is asking for the medication request not to occur.
dosageInstruction
  • Indicates how the medication is to be used by the patient.
encounter
  • The Encounter during which this [x] was created or to which the creation of this record is tightly associated.
eventHistory
  • Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
groupIdentifier
  • A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
instantiatesCanonical
  • The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.
instantiatesUri
  • The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.
insurance
  • Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
intent
  • Whether the request is a proposal, plan, or an original order.
language
  • The base language in which the resource is written.
medication
  • Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Extra information about the prescription that could not be conveyed by the other attributes.
performer
  • The specified desired performer of the medication treatment (e.g. the performer of the medication administration).
performerType
  • Indicates the type of performer of the administration of the medication.
priorPrescription
  • A link to a resource representing an earlier order related order or prescription.
priority
  • Indicates how quickly the Medication Request should be addressed with respect to other requests.
reasonCode
  • The reason or the indication for ordering or not ordering the medication.
reasonReference
  • Condition or observation that supports why the medication was ordered.
recorder
  • The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
reported
  • Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
requester
  • The individual, organization, or device that initiated the request and has responsibility for its activation.
status
  • A code specifying the current state of the order. Generally, this will be active or completed state.
statusReason
  • Captures the reason for the current state of the MedicationRequest.
subject
  • A link to a resource representing the person or set of individuals to whom the medication will be given.
substitution
  • Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.
supportingInformation
  • Include additional information (for example, patient height and weight) that supports the ordering of the medication.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields note, status, intent, subject, basedOn, category, priority, recorder, encounter, requester, performer, insurance, identifier, authoredOn, reasonCode, reported, statusReason, doNotPerform, eventHistory, medication, performerType, detectedIssue, reasonReference, instantiatesUri, groupIdentifier, dosageInstruction, priorPrescription, courseOfTherapyType, supportingInformation, instantiatesCanonical, substitution, dispenseRequest.

Companion:
object
object MedicationStatement extends CompanionFor[MedicationStatement]
Companion:
class
@POJOBoilerplate
class MedicationStatement(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val note: LitSeq[Annotation], val partOf: LitSeq[Reference], val status: MEDICATION_STATEMENT_STATUS, val dosage: LitSeq[Dosage], val basedOn: LitSeq[Reference], val subject: Reference, val context: Option[Reference], val language: Option[LANGUAGES], val category: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val derivedFrom: LitSeq[Reference], val statusReason: LitSeq[CodeableConcept], val effective: Option[EffectiveChoice], val dateAsserted: Option[FHIRDateTime], val implicitRules: Option[UriStr], val medication: MedicationChoice, val reasonReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val informationSource: Option[Reference], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.

A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
basedOn
  • A plan, proposal or order that is fulfilled in whole or in part by this event.
category
  • Indicates where the medication is expected to be consumed or administered.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
context
  • The encounter or episode of care that establishes the context for this MedicationStatement.
dateAsserted
  • The date when the medication statement was asserted by the information source.
derivedFrom
  • Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.
dosage
  • Indicates how the medication is/was or should be taken by the patient.
effective
  • The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No).
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
informationSource
  • The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest.
language
  • The base language in which the resource is written.
medication
  • Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Provides extra information about the medication statement that is not conveyed by the other attributes.
partOf
  • A larger event of which this particular event is a component or step.
reasonCode
  • A reason for why the medication is being/was taken.
reasonReference
  • Condition or observation that supports why the medication is being/was taken.
status
  • A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed.
statusReason
  • Captures the reason for the current state of the MedicationStatement.
subject
  • The person, animal or group who is/was taking the medication.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields note, partOf, status, dosage, basedOn, subject, context, category, identifier, reasonCode, derivedFrom, statusReason, effective, dateAsserted, medication, reasonReference, informationSource.

Companion:
object
object MedicinalProduct extends CompanionFor[MedicinalProduct]
Companion:
class
@POJOBoilerplate
class MedicinalProduct(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val domain: Option[Coding], val contact: LitSeq[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val masterFile: LitSeq[Reference], val implicitRules: Option[UriStr], val clinicalTrial: LitSeq[Reference], val crossReference: LitSeq[Identifier], val specialMeasures: LitSeq[String], val marketingStatus: LitSeq[Choice["MarketingStatus"]], val attachedDocument: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val legalStatusOfSupply: Option[CodeableConcept], val productClassification: LitSeq[CodeableConcept], val pharmaceuticalProduct: LitSeq[Reference], val paediatricUseIndicator: Option[CodeableConcept], val packagedMedicinalProduct: LitSeq[Reference], val additionalMonitoringIndicator: Option[CodeableConcept], val combinedPharmaceuticalDoseForm: Option[CodeableConcept], val specialDesignation: LitSeq[SpecialDesignation], val name: NonEmptyLitSeq[Name], val manufacturingBusinessOperation: LitSeq[ManufacturingBusinessOperation], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).

Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Regulatory type, e.g. Investigational or Authorized.
additionalMonitoringIndicator
  • Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.
attachedDocument
  • Supporting documentation, typically for regulatory submission.
clinicalTrial
  • Clinical trials or studies that this product is involved in.
combinedPharmaceuticalDoseForm
  • The dose form for a single part product, or combined form of a multiple part product.
contact
  • A product specific contact, person (in a role), or an organization.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
crossReference
  • Reference to another product, e.g. for linking authorised to investigational product.
domain
  • If this medicine applies to human or veterinary uses.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifier for this product. Could be an MPID.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
legalStatusOfSupply
  • The legal status of supply of the medicinal product as classified by the regulator.
manufacturingBusinessOperation
  • An operation applied to the product, for manufacturing or adminsitrative purpose.
marketingStatus
  • Marketing status of the medicinal product, in contrast to marketing authorizaton.
masterFile
  • A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • The product's name, including full name and possibly coded parts.
packagedMedicinalProduct
  • Package representation for the product.
paediatricUseIndicator
  • If authorised for use in children.
pharmaceuticalProduct
  • Pharmaceutical aspects of product.
productClassification
  • Allows the product to be classified by various systems.
specialDesignation
  • Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.
specialMeasures
  • Whether the Medicinal Product is subject to special measures for regulatory reasons.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, domain, contact, identifier, masterFile, clinicalTrial, crossReference, specialMeasures, marketingStatus, attachedDocument, legalStatusOfSupply, productClassification, pharmaceuticalProduct, paediatricUseIndicator, packagedMedicinalProduct, additionalMonitoringIndicator, combinedPharmaceuticalDoseForm, specialDesignation, name, manufacturingBusinessOperation.

Companion:
object
@POJOBoilerplate
class MedicinalProductAuthorization(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val status: Option[CodeableConcept], val holder: Option[Reference], val subject: Option[Reference], val country: LitSeq[CodeableConcept], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val regulator: Option[Reference], val identifier: LitSeq[Identifier], val statusDate: Option[FHIRDateTime], val legalBasis: Option[CodeableConcept], val restoreDate: Option[FHIRDateTime], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val validityPeriod: Option[Period], val modifierExtension: LitSeq[Extension], val dataExclusivityPeriod: Option[Period], val internationalBirthDate: Option[FHIRDateTime], val dateOfFirstAuthorization: Option[FHIRDateTime], val procedure: Option[Procedure], val jurisdictionalAuthorization: LitSeq[JurisdictionalAuthorization], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The regulatory authorization of a medicinal product.

The regulatory authorization of a medicinal product.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
country
  • The country in which the marketing authorization has been granted.
dataExclusivityPeriod
  • A period of time after authorization before generic product applicatiosn can be submitted.
dateOfFirstAuthorization
  • The date when the first authorization was granted by a Medicines Regulatory Agency.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
holder
  • Marketing Authorization Holder.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifier for the marketing authorization, as assigned by a regulator.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
internationalBirthDate
  • Date of first marketing authorization for a company's new medicinal product in any country in the World.
jurisdiction
  • Jurisdiction within a country.
jurisdictionalAuthorization
  • Authorization in areas within a country.
language
  • The base language in which the resource is written.
legalBasis
  • The legal framework against which this authorization is granted.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
procedure
  • The regulatory procedure for granting or amending a marketing authorization.
regulator
  • Medicines Regulatory Agency.
restoreDate
  • The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored.
status
  • The status of the marketing authorization.
statusDate
  • The date at which the given status has become applicable.
subject
  • The medicinal product that is being authorized.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
validityPeriod
  • The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format.
Constructor:

Introduces the fields status, holder, subject, country, regulator, identifier, statusDate, legalBasis, restoreDate, jurisdiction, validityPeriod, dataExclusivityPeriod, internationalBirthDate, dateOfFirstAuthorization, procedure, jurisdictionalAuthorization.

Companion:
object
@POJOBoilerplate
class MedicinalProductContraindication(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val subject: LitSeq[Reference], val disease: Option[CodeableConcept], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val population: LitSeq[Choice["Population"]], val comorbidity: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val diseaseStatus: Option[CodeableConcept], val modifierExtension: LitSeq[Extension], val therapeuticIndication: LitSeq[Reference], val otherTherapy: LitSeq[OtherTherapy], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.

The clinical particulars - indications, contraindications etc. of a medicinal product, including for regulatory purposes.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
comorbidity
  • A comorbidity (concurrent condition) or coinfection.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
disease
  • The disease, symptom or procedure for the contraindication.
diseaseStatus
  • The status of the disease or symptom for the contraindication.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
otherTherapy
  • Information about the use of the medicinal product in relation to other therapies described as part of the indication.
population
  • The population group to which this applies.
subject
  • The medication for which this is an indication.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
therapeuticIndication
  • Information about the use of the medicinal product in relation to other therapies as part of the indication.
Constructor:

Introduces the fields subject, disease, population, comorbidity, diseaseStatus, therapeuticIndication, otherTherapy.

Companion:
object
Companion:
class
@POJOBoilerplate
class MedicinalProductIndication(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val subject: LitSeq[Reference], val language: Option[LANGUAGES], val duration: Option[Quantity], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val population: LitSeq[Choice["Population"]], val comorbidity: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val diseaseStatus: Option[CodeableConcept], val intendedEffect: Option[CodeableConcept], val modifierExtension: LitSeq[Extension], val undesirableEffect: LitSeq[Reference], val diseaseSymptomProcedure: Option[CodeableConcept], val otherTherapy: LitSeq[OtherTherapy], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Indication for the Medicinal Product.

Indication for the Medicinal Product.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
comorbidity
  • Comorbidity (concurrent condition) or co-infection as part of the indication.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
diseaseStatus
  • The status of the disease or symptom for which the indication applies.
diseaseSymptomProcedure
  • The disease, symptom or procedure that is the indication for treatment.
duration
  • Timing or duration information as part of the indication.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
intendedEffect
  • The intended effect, aim or strategy to be achieved by the indication.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
otherTherapy
  • Information about the use of the medicinal product in relation to other therapies described as part of the indication.
population
  • The population group to which this applies.
subject
  • The medication for which this is an indication.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
undesirableEffect
  • Describe the undesirable effects of the medicinal product.
Constructor:

Introduces the fields subject, duration, population, comorbidity, diseaseStatus, intendedEffect, undesirableEffect, diseaseSymptomProcedure, otherTherapy.

Companion:
object
Companion:
class
@POJOBoilerplate
class MedicinalProductIngredient(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val role: CodeableConcept, val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: Option[Identifier], val manufacturer: LitSeq[Reference], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val allergenicIndicator: Option[Boolean], val substance: Option[Substance], val specifiedSubstance: LitSeq[SpecifiedSubstance], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

An ingredient of a manufactured item or pharmaceutical product.

An ingredient of a manufactured item or pharmaceutical product.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
allergenicIndicator
  • If the ingredient is a known or suspected allergen.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
manufacturer
  • Manufacturer of this Ingredient.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
role
  • Ingredient role e.g. Active ingredient, excipient.
specifiedSubstance
  • A specified substance that comprises this ingredient.
substance
  • The ingredient substance.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields role, identifier, manufacturer, allergenicIndicator, substance, specifiedSubstance.

Companion:
object
Companion:
class
@POJOBoilerplate
class MedicinalProductInteraction(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val effect: Option[CodeableConcept], val subject: LitSeq[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val incidence: Option[CodeableConcept], val management: Option[CodeableConcept], val description: Option[String], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val interactant: LitSeq[Interactant], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The interactions of the medicinal product with other medicinal products, or other forms of interactions.

The interactions of the medicinal product with other medicinal products, or other forms of interactions.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
description
  • The interaction described.
effect
  • The effect of the interaction, for example "reduced gastric absorption of primary medication".
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
incidence
  • The incidence of the interaction, e.g. theoretical, observed.
interactant
  • The specific medication, food or laboratory test that interacts.
language
  • The base language in which the resource is written.
management
  • Actions for managing the interaction.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
subject
  • The medication for which this is a described interaction.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, effect, subject, incidence, management, description, interactant.

Companion:
object
@POJOBoilerplate
class MedicinalProductManufactured(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val language: Option[LANGUAGES], val quantity: Quantity, val contained: LitSeq[Resource], val extension: LitSeq[Extension], val ingredient: LitSeq[Reference], val manufacturer: LitSeq[Reference], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val unitOfPresentation: Option[CodeableConcept], val manufacturedDoseForm: CodeableConcept, val otherCharacteristics: LitSeq[CodeableConcept], val physicalCharacteristics: Option[Choice["ProdCharacteristic"]], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The manufactured item as contained in the packaged medicinal product.

The manufactured item as contained in the packaged medicinal product.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
ingredient
  • Ingredient.
language
  • The base language in which the resource is written.
manufacturedDoseForm
  • Dose form as manufactured and before any transformation into the pharmaceutical product.
manufacturer
  • Manufacturer of the item (Note that this should be named "manufacturer" but it currently causes technical issues).
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
otherCharacteristics
  • Other codeable characteristics.
physicalCharacteristics
  • Dimensions, color etc.
quantity
  • The quantity or "count number" of the manufactured item.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
unitOfPresentation
  • The “real world” units in which the quantity of the manufactured item is described.
Constructor:

Introduces the fields quantity, ingredient, manufacturer, unitOfPresentation, manufacturedDoseForm, otherCharacteristics, physicalCharacteristics.

Companion:
object
Companion:
class
@POJOBoilerplate
class MedicinalProductPackaged(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val subject: LitSeq[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val description: Option[String], val manufacturer: LitSeq[Reference], val implicitRules: Option[UriStr], val marketingStatus: LitSeq[Choice["MarketingStatus"]], val modifierExtension: LitSeq[Extension], val legalStatusOfSupply: Option[CodeableConcept], val marketingAuthorization: Option[Reference], val batchIdentifier: LitSeq[BatchIdentifier], val packageItem: NonEmptyLitSeq[PackageItem], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A medicinal product in a container or package.

A medicinal product in a container or package.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
batchIdentifier
  • Batch numbering.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
description
  • Textual description.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Unique identifier.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
legalStatusOfSupply
  • The legal status of supply of the medicinal product as classified by the regulator.
manufacturer
  • Manufacturer of this Package Item.
marketingAuthorization
  • Manufacturer of this Package Item.
marketingStatus
  • Marketing information.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
packageItem
  • A packaging item, as a contained for medicine, possibly with other packaging items within.
subject
  • The product with this is a pack for.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields subject, identifier, description, manufacturer, marketingStatus, legalStatusOfSupply, marketingAuthorization, batchIdentifier, packageItem.

Companion:
object
@POJOBoilerplate
class MedicinalProductPharmaceutical(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val device: LitSeq[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val ingredient: LitSeq[Reference], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val unitOfPresentation: Option[CodeableConcept], val administrableDoseForm: CodeableConcept, val characteristics: LitSeq[Characteristics], val routeOfAdministration: NonEmptyLitSeq[RouteOfAdministration], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A pharmaceutical product described in terms of its composition and dose form.

A pharmaceutical product described in terms of its composition and dose form.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
administrableDoseForm
  • The administrable dose form, after necessary reconstitution.
characteristics
  • Characteristics e.g. a products onset of action.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
device
  • Accompanying device.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • An identifier for the pharmaceutical medicinal product.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
ingredient
  • Ingredient.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
routeOfAdministration
  • The path by which the pharmaceutical product is taken into or makes contact with the body.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
unitOfPresentation
  • Todo.
Constructor:

Introduces the fields device, identifier, ingredient, unitOfPresentation, administrableDoseForm, characteristics, routeOfAdministration.

Companion:
object
@POJOBoilerplate
class MedicinalProductUndesirableEffect(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val subject: LitSeq[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val population: LitSeq[Choice["Population"]], val implicitRules: Option[UriStr], val classification: Option[CodeableConcept], val modifierExtension: LitSeq[Extension], val frequencyOfOccurrence: Option[CodeableConcept], val symptomConditionEffect: Option[CodeableConcept], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Describe the undesirable effects of the medicinal product.

Describe the undesirable effects of the medicinal product.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
classification
  • Classification of the effect.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
frequencyOfOccurrence
  • The frequency of occurrence of the effect.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
population
  • The population group to which this applies.
subject
  • The medication for which this is an indication.
symptomConditionEffect
  • The symptom, condition or undesirable effect.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields subject, population, classification, frequencyOfOccurrence, symptomConditionEffect.

Companion:
object
object MessageDefinition extends CompanionFor[MessageDefinition]
Companion:
class
@POJOBoilerplate
class MessageDefinition(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: FHIRDateTime, val base: Option[Canonical], val title: Option[String], val graph: LitSeq[Canonical], val status: PUBLICATION_STATUS, val parent: LitSeq[Canonical], val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val language: Option[LANGUAGES], val replaces: LitSeq[Canonical], val event: EventChoice, val category: Option[MESSAGE_SIGNIFICANCE_CATEGORY], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val responseRequired: Option[MESSAGEHEADER_RESPONSE_REQUEST], val modifierExtension: LitSeq[Extension], val focus: LitSeq[Focus], val allowedResponse: LitSeq[AllowedResponse], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
allowedResponse
  • Indicates what types of messages may be sent as an application-level response to this message.
base
  • The MessageDefinition that is the basis for the contents of this resource.
category
  • The impact of the content of the message.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.
date
  • The date (and optionally time) when the message definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes.
description
  • A free text natural language description of the message definition from a consumer's perspective.
event
  • Event code or link to the EventDefinition.
experimental
  • A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
focus
  • Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.
graph
  • Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the message definition is intended to be used.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
parent
  • Identifies a protocol or workflow that this MessageDefinition represents a step in.
publisher
  • The name of the organization or individual that published the message definition.
purpose
  • Explanation of why this message definition is needed and why it has been designed as it has.
replaces
  • A MessageDefinition that is superseded by this definition.
responseRequired
  • Declare at a message definition level whether a response is required or only upon error or success, or never.
status
  • The status of this message definition. Enables tracking the life-cycle of the content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the message definition.
url
  • The business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances.
version
  • The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, base, title, graph, status, parent, version, contact, purpose, replaces, event, category, publisher, copyright, identifier, useContext, description, experimental, jurisdiction, responseRequired, focus, allowedResponse.

Companion:
object
object MessageHeader extends CompanionFor[MessageHeader]
Companion:
class
@POJOBoilerplate
class MessageHeader(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val focus: LitSeq[Reference], val sender: Option[Reference], val author: Option[Reference], val reason: Option[CodeableConcept], val enterer: Option[Reference], val language: Option[LANGUAGES], val event: EventChoice, val contained: LitSeq[Resource], val extension: LitSeq[Extension], val definition: Option[Canonical], val responsible: Option[Reference], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val source: Source, val response: Option[Response], val destination: LitSeq[Destination], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
author
  • The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
definition
  • Permanent link to the MessageDefinition for this message.
destination
  • The destination application which the message is intended for.
enterer
  • The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
event
  • Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
focus
  • The actual data of the message - a reference to the root/focus class of the event.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
reason
  • Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
response
  • Information about the message that this message is a response to. Only present if this message is a response.
responsible
  • The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.
sender
  • Identifies the sending system to allow the use of a trust relationship.
source
  • The source application from which this message originated.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields focus, sender, author, reason, enterer, event, definition, responsible, source, response, destination.

Companion:
object
object MolecularSequence extends CompanionFor[MolecularSequence]
Companion:
class
@POJOBoilerplate
class MolecularSequence(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[SEQUENCE_TYPE], val device: Option[Reference], val patient: Option[Reference], val pointer: LitSeq[Reference], val language: Option[LANGUAGES], val specimen: Option[Reference], val quantity: Option[Quantity], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val performer: Option[Reference], val identifier: LitSeq[Identifier], val observedSeq: Option[String], val readCoverage: Option[Int], val implicitRules: Option[UriStr], val coordinateSystem: Int, val modifierExtension: LitSeq[Extension], val variant: LitSeq[Variant], val repository: LitSeq[Repository], val quality: LitSeq[Quality], val referenceSeq: Option[ReferenceSeq], val structureVariant: LitSeq[StructureVariant], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Raw data describing a biological sequence.

Raw data describing a biological sequence.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Amino Acid Sequence/ DNA Sequence / RNA Sequence.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
coordinateSystem
  • Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end).
device
  • The method for sequencing, for example, chip information.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier for this particular sequence instance. This is a FHIR-defined id.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
observedSeq
  • Sequence that was observed. It is the result marked by referenceSeq along with variant records on referenceSeq. This shall start from referenceSeq.windowStart and end by referenceSeq.windowEnd.
patient
  • The patient whose sequencing results are described by this resource.
performer
  • The organization or lab that should be responsible for this result.
pointer
  • Pointer to next atomic sequence which at most contains one variant.
quality
  • An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score (SO:0001686).
quantity
  • The number of copies of the sequence of interest. (RNASeq).
readCoverage
  • Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.
referenceSeq
  • A sequence that is used as a reference to describe variants that are present in a sequence analyzed.
repository
  • Configurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq.
specimen
  • Specimen used for sequencing.
structureVariant
  • Information about chromosome structure variation.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
variant
  • The definition of variant here originates from Sequence ontology (variant_of). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string.
Constructor:

Introduces the fields type, device, patient, pointer, specimen, quantity, performer, identifier, observedSeq, readCoverage, coordinateSystem, variant, repository, quality, referenceSeq, structureVariant.

Companion:
object
object MoneyQuantity extends CompanionFor[MoneyQuantity]
Companion:
class
@POJOBoilerplate
class MoneyQuantity(val id: Option[String], val unit: Option[String], val code: Option[Code], val value: Option[BigDecimal], val system: Option[UriStr], val extension: LitSeq[Extension], val comparator: Option[QUANTITY_COMPARATOR], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Quantity

An amount of money. With regard to precision, see Decimal Precision

An amount of money. With regard to precision, see Decimal Precision

Subclass of core.model.Quantity (Base StructureDefinition for Quantity Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.)

Value parameters:
code
  • A computer processable form of the unit in some unit representation system.
comparator
  • How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
system
  • The identification of the system that provides the coded form of the unit.
unit
  • A human-readable form of the unit.
value
  • The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Constructor:

Inherits all params from parent.

Companion:
object
object NamingSystem extends CompanionFor[NamingSystem]
Companion:
class
@POJOBoilerplate
class NamingSystem(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val name: String, val kind: NAMINGSYSTEM_TYPE, val date: FHIRDateTime, `type`: Option[CodeableConcept], val usage: Option[String], val status: PUBLICATION_STATUS, val contact: LitSeq[ContactDetail], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val useContext: LitSeq[UsageContext], val responsible: Option[String], val description: Option[Markdown], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val uniqueId: NonEmptyLitSeq[UniqueId], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.

A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Categorizes a naming system for easier search by grouping related naming systems.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
date
  • The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.
description
  • A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the naming system is intended to be used.
kind
  • Indicates the purpose for the naming system - what kinds of things does it make unique?
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the naming system.
responsible
  • The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
status
  • The status of this naming system. Enables tracking the life-cycle of the content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
uniqueId
  • Indicates how the system may be identified when referenced in electronic exchange.
usage
  • Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.
Constructor:

Introduces the fields name, kind, date, type, usage, status, contact, publisher, useContext, responsible, description, jurisdiction, uniqueId.

Companion:
object
object Narrative extends CompanionFor[Narrative]
Companion:
class
@POJOBoilerplate
class Narrative(val id: Option[String], val div: XHTML, val status: NARRATIVE_STATUS, val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Element

Base StructureDefinition for Narrative Type: A human-readable summary of the resource conveying the essential clinical and business information for the resource.

Base StructureDefinition for Narrative Type: A human-readable summary of the resource conveying the essential clinical and business information for the resource.

Subclass of core.model.Element (Base StructureDefinition for Element Type: Base definition for all elements in a resource.)

Value parameters:
div
  • The actual narrative content, a stripped down version of XHTML.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
status
  • The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Constructor:

Introduces the fields div, status.

Companion:
object
object NutritionOrder extends CompanionFor[NutritionOrder]
Companion:
class
@POJOBoilerplate
class NutritionOrder(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val note: LitSeq[Annotation], val status: REQUEST_STATUS, val intent: REQUEST_INTENT, val patient: Reference, val orderer: Option[Reference], val language: Option[LANGUAGES], val dateTime: FHIRDateTime, val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val instantiates: LitSeq[UriStr], val implicitRules: Option[UriStr], val instantiatesUri: LitSeq[UriStr], val modifierExtension: LitSeq[Extension], val allergyIntolerance: LitSeq[Reference], val excludeFoodModifier: LitSeq[CodeableConcept], val instantiatesCanonical: LitSeq[Canonical], val foodPreferenceModifier: LitSeq[CodeableConcept], val supplement: LitSeq[Supplement], val oralDiet: Option[OralDiet], val enteralFormula: Option[EnteralFormula], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
allergyIntolerance
  • A link to a record of allergies or intolerances which should be included in the nutrition order.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
dateTime
  • The date and time that this nutrition order was requested.
encounter
  • An encounter that provides additional information about the healthcare context in which this request is made.
enteralFormula
  • Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.
excludeFoodModifier
  • This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
foodPreferenceModifier
  • This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers assigned to this order by the order sender or by the order receiver.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
instantiates
  • The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
instantiatesCanonical
  • The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
instantiatesUri
  • The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
intent
  • Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Comments made about the {{title}} by the requester, performer, subject or other participants.
oralDiet
  • Diet given orally in contrast to enteral (tube) feeding.
orderer
  • The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
patient
  • The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
status
  • The workflow status of the nutrition order/request.
supplement
  • Oral nutritional products given in order to add further nutritional value to the patient's diet.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields note, status, intent, patient, orderer, dateTime, encounter, identifier, instantiates, instantiatesUri, allergyIntolerance, excludeFoodModifier, instantiatesCanonical, foodPreferenceModifier, supplement, oralDiet, enteralFormula.

Companion:
object
object Observation extends CompanionFor[Observation]
Companion:
class
@POJOBoilerplate
class Observation(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: CodeableConcept, val note: LitSeq[Annotation], val focus: LitSeq[Reference], val partOf: LitSeq[Reference], val status: OBSERVATION_STATUS, val issued: Option[ZonedDateTime], val method: Option[CodeableConcept], val device: Option[Reference], val basedOn: LitSeq[Reference], val subject: Option[Reference], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val value: Option[ValueChoice], val bodySite: Option[CodeableConcept], val specimen: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val performer: LitSeq[Reference], val hasMember: LitSeq[Reference], val identifier: LitSeq[Identifier], val derivedFrom: LitSeq[Reference], val effective: Option[EffectiveChoice], val implicitRules: Option[UriStr], val interpretation: LitSeq[CodeableConcept], val dataAbsentReason: Option[CodeableConcept], val modifierExtension: LitSeq[Extension], val component: LitSeq[Component], val referenceRange: LitSeq[ReferenceRange], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Measurements and simple assertions made about a patient, device or other subject.

Measurements and simple assertions made about a patient, device or other subject.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
basedOn
  • A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
bodySite
  • Indicates the site on the subject's body where the observation was made (i.e. the target site).
category
  • A code that classifies the general type of observation being made.
code
  • Describes what was observed. Sometimes this is called the observation "name".
component
  • Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
dataAbsentReason
  • Provides a reason why the expected value in the element Observation.value[x] is missing.
derivedFrom
  • The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
device
  • The device used to generate the observation data.
effective
  • The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
encounter
  • The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
focus
  • The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
hasMember
  • This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this observation.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
interpretation
  • A categorical assessment of an observation value. For example, high, low, normal.
issued
  • The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
method
  • Indicates the mechanism used to perform the observation.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Comments about the observation or the results.
partOf
  • A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure.
performer
  • Who was responsible for asserting the observed value as "true".
referenceRange
  • Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two referenceRange elements would be used.
specimen
  • The specimen that was used when this observation was made.
status
  • The status of the result value.
subject
  • The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
value
  • The information determined as a result of making the observation, if the information has a simple value.
Constructor:

Introduces the fields code, note, focus, partOf, status, issued, method, device, basedOn, subject, category, value, bodySite, specimen, encounter, performer, hasMember, identifier, derivedFrom, effective, interpretation, dataAbsentReason, component, referenceRange.

Companion:
object
object ObservationDefinition extends CompanionFor[ObservationDefinition]
Companion:
class
@POJOBoilerplate
class ObservationDefinition(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: CodeableConcept, val method: Option[CodeableConcept], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val permittedDataType: LitSeq[PERMITTED_DATA_TYPE], val validCodedValueSet: Option[Reference], val preferredReportName: Option[String], val normalCodedValueSet: Option[Reference], val abnormalCodedValueSet: Option[Reference], val criticalCodedValueSet: Option[Reference], val multipleResultsAllowed: Option[Boolean], val qualifiedInterval: LitSeq[QualifiedInterval], val quantitativeDetails: Option[QuantitativeDetails], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
abnormalCodedValueSet
  • The set of abnormal coded results for the observation conforming to this ObservationDefinition.
category
  • A code that classifies the general type of observation.
code
  • Describes what will be observed. Sometimes this is called the observation "name".
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
criticalCodedValueSet
  • The set of critical coded results for the observation conforming to this ObservationDefinition.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this ObservationDefinition artifact.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
method
  • The method or technique used to perform the observation.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
multipleResultsAllowed
  • Multiple results allowed for observations conforming to this ObservationDefinition.
normalCodedValueSet
  • The set of normal coded results for the observations conforming to this ObservationDefinition.
permittedDataType
  • The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.
preferredReportName
  • The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
qualifiedInterval
  • Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.
quantitativeDetails
  • Characteristics for quantitative results of this observation.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
validCodedValueSet
  • The set of valid coded results for the observations conforming to this ObservationDefinition.
Constructor:

Introduces the fields code, method, category, identifier, permittedDataType, validCodedValueSet, preferredReportName, normalCodedValueSet, abnormalCodedValueSet, criticalCodedValueSet, multipleResultsAllowed, qualifiedInterval, quantitativeDetails.

Companion:
object
object OperationDefinition extends CompanionFor[OperationDefinition]
Companion:
class
@POJOBoilerplate
class OperationDefinition(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: String, val kind: OPERATION_KIND, val date: Option[FHIRDateTime], val code: Code, val base: Option[Canonical], `type`: Boolean, val title: Option[String], val status: PUBLICATION_STATUS, val system: Boolean, val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val comment: Option[Markdown], val language: Option[LANGUAGES], val resource: LitSeq[RESOURCE_TYPES], val instance: Boolean, val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val affectsState: Option[Boolean], val inputProfile: Option[Canonical], val implicitRules: Option[UriStr], val outputProfile: Option[Canonical], val modifierExtension: LitSeq[Extension], val overload: LitSeq[Overload], val parameter: LitSeq[Parameter], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).
affectsState
  • Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
base
  • Indicates that this operation definition is a constraining profile on the base.
code
  • The name used to invoke the operation.
comment
  • Additional information about how to use this operation or named query.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
date
  • The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.
description
  • A free text natural language description of the operation definition from a consumer's perspective.
experimental
  • A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
inputProfile
  • Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.
instance
  • Indicates whether this operation can be invoked on a particular instance of one of the given types.
jurisdiction
  • A legal or geographic region in which the operation definition is intended to be used.
kind
  • Whether this is an operation or a named query.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
outputProfile
  • Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
overload
  • Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.
parameter
  • The parameters for the operation/query.
publisher
  • The name of the organization or individual that published the operation definition.
purpose
  • Explanation of why this operation definition is needed and why it has been designed as it has.
resource
  • The types on which this operation can be executed.
status
  • The status of this operation definition. Enables tracking the life-cycle of the content.
system
  • Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the operation definition.
url
  • An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate operation definition instances.
version
  • The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, kind, date, code, base, type, title, status, system, version, contact, purpose, comment, resource, instance, publisher, useContext, description, experimental, jurisdiction, affectsState, inputProfile, outputProfile, overload, parameter.

Companion:
object
object OperationOutcome extends CompanionFor[OperationOutcome]
Companion:
class
@POJOBoilerplate
class OperationOutcome(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val issue: NonEmptyLitSeq[Issue], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A collection of error, warning, or information messages that result from a system action.

A collection of error, warning, or information messages that result from a system action.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
issue
  • An error, warning, or information message that results from a system action.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields issue.

Companion:
object
object Organization extends CompanionFor[Organization]
Companion:
class
@POJOBoilerplate
class Organization(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: LitSeq[CodeableConcept], val name: Option[String], val alias: LitSeq[String], val active: Option[Boolean], val partOf: Option[Reference], val telecom: LitSeq[ContactPoint], val address: LitSeq[Address], val language: Option[LANGUAGES], val endpoint: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val contact: LitSeq[Contact], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The kind(s) of organization that this is.
active
  • Whether the organization's record is still in active use.
address
  • An address for the organization.
alias
  • A list of alternate names that the organization is known as, or was known as in the past.
contact
  • Contact for the organization for a certain purpose.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
endpoint
  • Technical endpoints providing access to services operated for the organization.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifier for the organization that is used to identify the organization across multiple disparate systems.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A name associated with the organization.
partOf
  • The organization of which this organization forms a part.
telecom
  • A contact detail for the organization.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, name, alias, active, partOf, telecom, address, endpoint, identifier, contact.

Companion:
object
Companion:
class
@POJOBoilerplate
class OrganizationAffiliation(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: LitSeq[CodeableConcept], val active: Option[Boolean], val period: Option[Period], val network: LitSeq[Reference], val telecom: LitSeq[ContactPoint], val language: Option[LANGUAGES], val location: LitSeq[Reference], val endpoint: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val specialty: LitSeq[CodeableConcept], val identifier: LitSeq[Identifier], val organization: Option[Reference], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val healthcareService: LitSeq[Reference], val participatingOrganization: Option[Reference], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.

Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
active
  • Whether this organization affiliation record is in active use.
code
  • Definition of the role the participatingOrganization plays in the association.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
endpoint
  • Technical endpoints providing access to services operated for this role.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
healthcareService
  • Healthcare services provided through the role.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers that are specific to this role.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
location
  • The location(s) at which the role occurs.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
network
  • Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).
organization
  • Organization where the role is available (primary organization/has members).
participatingOrganization
  • The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).
period
  • The period during which the participatingOrganization is affiliated with the primary organization.
specialty
  • Specific specialty of the participatingOrganization in the context of the role.
telecom
  • Contact details at the participatingOrganization relevant to this Affiliation.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, active, period, network, telecom, location, endpoint, specialty, identifier, organization, healthcareService, participatingOrganization.

Companion:
object
object Parameters extends CompanionFor[Parameters]
Companion:
class
@POJOBoilerplate
class Parameters(val id: Option[String], val meta: Option[Meta], val language: Option[LANGUAGES], val implicitRules: Option[UriStr], val parameter: LitSeq[Parameter], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Resource

This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

This resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it.

Subclass of core.model.Resource (This is the base resource type for everything.)

Value parameters:
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
parameter
  • A parameter passed to or received from the operation.
Constructor:

Introduces the fields parameter.

Companion:
object
object Patient extends CompanionFor[Patient]
Companion:
class
@POJOBoilerplate
class Patient(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val name: LitSeq[HumanName], val photo: LitSeq[Attachment], val active: Option[Boolean], val gender: Option[ADMINISTRATIVE_GENDER], val telecom: LitSeq[ContactPoint], val address: LitSeq[Address], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val birthDate: Option[FHIRDate], val identifier: LitSeq[Identifier], val deceased: Option[DeceasedChoice], val implicitRules: Option[UriStr], val maritalStatus: Option[CodeableConcept], val multipleBirth: Option[MultipleBirthChoice], val modifierExtension: LitSeq[Extension], val generalPractitioner: LitSeq[Reference], val managingOrganization: Option[Reference], val link: LitSeq[Link], val contact: LitSeq[Contact], val communication: LitSeq[Communication], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
active
  • Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
address
  • An address for the individual.
birthDate
  • The date of birth for the individual.
communication
  • A language which may be used to communicate with the patient about his or her health.
contact
  • A contact party (e.g. guardian, partner, friend) for the patient.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
deceased
  • Indicates if the individual is deceased or not.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
gender
  • Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
generalPractitioner
  • Patient's nominated care provider.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • An identifier for this patient.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
link
  • Link to another patient resource that concerns the same actual patient.
managingOrganization
  • Organization that is the custodian of the patient record.
maritalStatus
  • This field contains a patient's most recent marital (civil) status.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
multipleBirth
  • Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
name
  • A name associated with the individual.
photo
  • Image of the patient.
telecom
  • A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields name, photo, active, gender, telecom, address, birthDate, identifier, deceased, maritalStatus, multipleBirth, generalPractitioner, managingOrganization, link, contact, communication.

Companion:
object
object PaymentNotice extends CompanionFor[PaymentNotice]
Companion:
class
@POJOBoilerplate
class PaymentNotice(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val payee: Option[Reference], val status: FM_STATUS, val amount: Money, val request: Option[Reference], val created: FHIRDateTime, val payment: Reference, val language: Option[LANGUAGES], val response: Option[Reference], val provider: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val recipient: Reference, val identifier: LitSeq[Identifier], val paymentDate: Option[FHIRDate], val implicitRules: Option[UriStr], val paymentStatus: Option[CodeableConcept], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

This resource provides the status of the payment for goods and services rendered, and the request and response resource references.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
amount
  • The amount sent to the payee.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
created
  • The date when this resource was created.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this payment notice.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
payee
  • The party who will receive or has received payment that is the subject of this notification.
payment
  • A reference to the payment which is the subject of this notice.
paymentDate
  • The date when the above payment action occurred.
paymentStatus
  • A code indicating whether payment has been sent or cleared.
provider
  • The practitioner who is responsible for the services rendered to the patient.
recipient
  • The party who is notified of the payment status.
request
  • Reference of resource for which payment is being made.
response
  • Reference of response to resource for which payment is being made.
status
  • The status of the resource instance.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields payee, status, amount, request, created, payment, response, provider, recipient, identifier, paymentDate, paymentStatus.

Companion:
object
object PaymentReconciliation extends CompanionFor[PaymentReconciliation]
Companion:
class
@POJOBoilerplate
class PaymentReconciliation(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val status: FM_STATUS, val period: Option[Period], val created: FHIRDateTime, val request: Option[Reference], val outcome: Option[REMITTANCE_OUTCOME], val language: Option[LANGUAGES], val formCode: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val requestor: Option[Reference], val identifier: LitSeq[Identifier], val disposition: Option[String], val paymentDate: FHIRDate, val implicitRules: Option[UriStr], val paymentIssuer: Option[Reference], val paymentAmount: Money, val modifierExtension: LitSeq[Extension], val paymentIdentifier: Option[Identifier], val detail: LitSeq[Detail], val processNote: LitSeq[ProcessNote], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

This resource provides the details including amount of a payment and allocates the payment items being paid.

This resource provides the details including amount of a payment and allocates the payment items being paid.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
created
  • The date when the resource was created.
detail
  • Distribution of the payment amount for a previously acknowledged payable.
disposition
  • A human readable description of the status of the request for the reconciliation.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
formCode
  • A code for the form to be used for printing the content.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this payment reconciliation.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
outcome
  • The outcome of a request for a reconciliation.
paymentAmount
  • Total payment amount as indicated on the financial instrument.
paymentDate
  • The date of payment as indicated on the financial instrument.
paymentIdentifier
  • Issuer's unique identifier for the payment instrument.
paymentIssuer
  • The party who generated the payment.
period
  • The period of time for which payments have been gathered into this bulk payment for settlement.
processNote
  • A note that describes or explains the processing in a human readable form.
request
  • Original request resource reference.
requestor
  • The practitioner who is responsible for the services rendered to the patient.
status
  • The status of the resource instance.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields status, period, created, request, outcome, formCode, requestor, identifier, disposition, paymentDate, paymentIssuer, paymentAmount, paymentIdentifier, detail, processNote.

Companion:
object
object Person extends CompanionFor[Person]
Companion:
class
@POJOBoilerplate
class Person(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val name: LitSeq[HumanName], val photo: Option[Attachment], val gender: Option[ADMINISTRATIVE_GENDER], val active: Option[Boolean], val telecom: LitSeq[ContactPoint], val address: LitSeq[Address], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val birthDate: Option[FHIRDate], val identifier: LitSeq[Identifier], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val managingOrganization: Option[Reference], val link: LitSeq[Link], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Demographics and administrative information about a person independent of a specific health-related context.

Demographics and administrative information about a person independent of a specific health-related context.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
active
  • Whether this person's record is in active use.
address
  • One or more addresses for the person.
birthDate
  • The birth date for the person.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
gender
  • Administrative Gender.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifier for a person within a particular scope.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
link
  • Link to a resource that concerns the same actual person.
managingOrganization
  • The organization that is the custodian of the person record.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A name associated with the person.
photo
  • An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
telecom
  • A contact detail for the person, e.g. a telephone number or an email address.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields name, photo, gender, active, telecom, address, birthDate, identifier, managingOrganization, link.

Companion:
object
object PlanDefinition extends CompanionFor[PlanDefinition]
Companion:
class
@POJOBoilerplate
class PlanDefinition(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], `type`: Option[CodeableConcept], val date: Option[FHIRDateTime], val title: Option[String], val usage: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val library: LitSeq[Canonical], val language: Option[LANGUAGES], val subtitle: Option[String], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val subject: Option[SubjectChoice], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val modifierExtension: LitSeq[Extension], val goal: LitSeq[Goal], val action: LitSeq[Action], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
action
  • An action or group of actions to be taken as part of the plan.
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
date
  • The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.
description
  • A free text natural language description of the plan definition from a consumer's perspective.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectivePeriod
  • The period during which the plan definition content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
experimental
  • A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
goal
  • Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the plan definition is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
library
  • A reference to a Library resource containing any formal logic used by the plan definition.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the plan definition.
purpose
  • Explanation of why this plan definition is needed and why it has been designed as it has.
relatedArtifact
  • Related artifacts such as additional documentation, justification, or bibliographic references.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
status
  • The status of this plan definition. Enables tracking the life-cycle of the content.
subject
  • A code or group definition that describes the intended subject of the plan definition.
subtitle
  • An explanatory or alternate title for the plan definition giving additional information about its content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the plan definition.
topic
  • Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.
url
  • An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.
usage
  • A detailed description of how the plan definition is used from a clinical perspective.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
version
  • The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
Constructor:

Introduces the fields url, name, type, date, title, usage, topic, status, author, editor, version, contact, purpose, library, subtitle, reviewer, endorser, publisher, copyright, identifier, subject, useContext, description, experimental, jurisdiction, approvalDate, lastReviewDate, effectivePeriod, relatedArtifact, goal, action.

Companion:
object
object Practitioner extends CompanionFor[Practitioner]
Companion:
class
@POJOBoilerplate
class Practitioner(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val name: LitSeq[HumanName], val photo: LitSeq[Attachment], val active: Option[Boolean], val gender: Option[ADMINISTRATIVE_GENDER], val telecom: LitSeq[ContactPoint], val address: LitSeq[Address], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val birthDate: Option[FHIRDate], val identifier: LitSeq[Identifier], val implicitRules: Option[UriStr], val communication: LitSeq[CodeableConcept], val modifierExtension: LitSeq[Extension], val qualification: LitSeq[Qualification], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A person who is directly or indirectly involved in the provisioning of healthcare.

A person who is directly or indirectly involved in the provisioning of healthcare.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
active
  • Whether this practitioner's record is in active use.
address
  • Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
birthDate
  • The date of birth for the practitioner.
communication
  • A language the practitioner can use in patient communication.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
gender
  • Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • An identifier that applies to this person in this role.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • The name(s) associated with the practitioner.
photo
  • Image of the person.
qualification
  • The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
telecom
  • A contact detail for the practitioner, e.g. a telephone number or an email address.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields name, photo, active, gender, telecom, address, birthDate, identifier, communication, qualification.

Companion:
object
object PractitionerRole extends CompanionFor[PractitionerRole]
Companion:
class
@POJOBoilerplate
class PractitionerRole(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: LitSeq[CodeableConcept], val active: Option[Boolean], val period: Option[Period], val telecom: LitSeq[ContactPoint], val language: Option[LANGUAGES], val location: LitSeq[Reference], val endpoint: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val specialty: LitSeq[CodeableConcept], val identifier: LitSeq[Identifier], val practitioner: Option[Reference], val organization: Option[Reference], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val healthcareService: LitSeq[Reference], val availabilityExceptions: Option[String], val notAvailable: LitSeq[NotAvailable], val availableTime: LitSeq[AvailableTime], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
active
  • Whether this practitioner role record is in active use.
availabilityExceptions
  • A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
availableTime
  • A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
code
  • Roles which this practitioner is authorized to perform for the organization.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
endpoint
  • Technical endpoints providing access to services operated for the practitioner with this role.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
healthcareService
  • The list of healthcare services that this worker provides for this role's Organization/Location(s).
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business Identifiers that are specific to a role/location.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
location
  • The location(s) at which this practitioner provides care.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
notAvailable
  • The practitioner is not available or performing this role during this period of time due to the provided reason.
organization
  • The organization where the Practitioner performs the roles associated.
period
  • The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
practitioner
  • Practitioner that is able to provide the defined services for the organization.
specialty
  • Specific specialty of the practitioner.
telecom
  • Contact details that are specific to the role/location/service.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, active, period, telecom, location, endpoint, specialty, identifier, practitioner, organization, healthcareService, availabilityExceptions, notAvailable, availableTime.

Companion:
object
object Procedure extends CompanionFor[Procedure]
Companion:
class
@POJOBoilerplate
class Procedure(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val note: LitSeq[Annotation], val partOf: LitSeq[Reference], val status: EVENT_STATUS, val report: LitSeq[Reference], val basedOn: LitSeq[Reference], val subject: Reference, val outcome: Option[CodeableConcept], val language: Option[LANGUAGES], val category: Option[CodeableConcept], val recorder: Option[Reference], val asserter: Option[Reference], val location: Option[Reference], val bodySite: LitSeq[CodeableConcept], val followUp: LitSeq[CodeableConcept], val usedCode: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val statusReason: Option[CodeableConcept], val performed: Option[PerformedChoice], val complication: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val usedReference: LitSeq[Reference], val instantiatesUri: LitSeq[UriStr], val reasonReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val complicationDetail: LitSeq[Reference], val instantiatesCanonical: LitSeq[Canonical], val performer: LitSeq[Performer], val focalDevice: LitSeq[FocalDevice], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.

An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
asserter
  • Individual who is making the procedure statement.
basedOn
  • A reference to a resource that contains details of the request for this procedure.
bodySite
  • Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
category
  • A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
code
  • The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").
complication
  • Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.
complicationDetail
  • Any complications that occurred during the procedure, or in the immediate post-performance period.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
encounter
  • The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
focalDevice
  • A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.
followUp
  • If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
instantiatesCanonical
  • The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
instantiatesUri
  • The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.
language
  • The base language in which the resource is written.
location
  • The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Any other notes and comments about the procedure.
outcome
  • The outcome of the procedure - did it resolve the reasons for the procedure being performed?
partOf
  • A larger event of which this particular procedure is a component or step.
performed
  • Estimated or actual date, date-time, period, or age when the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
performer
  • Limited to "real" people rather than equipment.
reasonCode
  • The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.
reasonReference
  • The justification of why the procedure was performed.
recorder
  • Individual who recorded the record and takes responsibility for its content.
report
  • This could be a histology result, pathology report, surgical report, etc.
status
  • A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
statusReason
  • Captures the reason for the current state of the procedure.
subject
  • The person, animal or group on which the procedure was performed.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
usedCode
  • Identifies coded items that were used as part of the procedure.
usedReference
  • Identifies medications, devices and any other substance used as part of the procedure.
Constructor:

Introduces the fields code, note, partOf, status, report, basedOn, subject, outcome, category, recorder, asserter, location, bodySite, followUp, usedCode, encounter, identifier, reasonCode, statusReason, performed, complication, usedReference, instantiatesUri, reasonReference, complicationDetail, instantiatesCanonical, performer, focalDevice.

Companion:
object
object Provenance extends CompanionFor[Provenance]
Companion:
class
@POJOBoilerplate
class Provenance(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val target: NonEmptyLitSeq[Reference], val policy: LitSeq[UriStr], val reason: LitSeq[CodeableConcept], val language: Option[LANGUAGES], val recorded: ZonedDateTime, val location: Option[Reference], val activity: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val signature: LitSeq[Signature], val occurred: Option[OccurredChoice], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val agent: NonEmptyLitSeq[Agent], val entity: LitSeq[Entity], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
activity
  • An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
agent
  • An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
entity
  • An entity used in this activity.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
location
  • Where the activity occurred, if relevant.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
occurred
  • The period during which the activity occurred.
policy
  • Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
reason
  • The reason that the activity was taking place.
recorded
  • The instant of time at which the activity was recorded.
signature
  • A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
target
  • The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields target, policy, reason, recorded, location, activity, signature, occurred, agent, entity.

Companion:
object
object Questionnaire extends CompanionFor[Questionnaire]
Companion:
class
@POJOBoilerplate
class Questionnaire(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], val code: LitSeq[Coding], val title: Option[String], val status: PUBLICATION_STATUS, val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], val derivedFrom: LitSeq[Canonical], val subjectType: LitSeq[RESOURCE_TYPES], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val modifierExtension: LitSeq[Extension], val item: LitSeq[Item], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.

A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
code
  • An identifier for this question or group of questions in a particular terminology such as LOINC.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.
date
  • The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.
derivedFrom
  • The URL of a Questionnaire that this Questionnaire is based on.
description
  • A free text natural language description of the questionnaire from a consumer's perspective.
effectivePeriod
  • The period during which the questionnaire content was or is planned to be in active use.
experimental
  • A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
item
  • A particular question, question grouping or display text that is part of the questionnaire.
jurisdiction
  • A legal or geographic region in which the questionnaire is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the questionnaire.
purpose
  • Explanation of why this questionnaire is needed and why it has been designed as it has.
status
  • The status of this questionnaire. Enables tracking the life-cycle of the content.
subjectType
  • The types of subjects that can be the subject of responses created for the questionnaire.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the questionnaire.
url
  • An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.
version
  • The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, code, title, status, version, contact, purpose, publisher, copyright, identifier, useContext, derivedFrom, subjectType, description, experimental, jurisdiction, approvalDate, lastReviewDate, effectivePeriod, item.

Companion:
object
object QuestionnaireResponse extends CompanionFor[QuestionnaireResponse]
Companion:
class
@POJOBoilerplate
class QuestionnaireResponse(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val partOf: LitSeq[Reference], val status: QUESTIONNAIRE_ANSWERS_STATUS, val author: Option[Reference], val source: Option[Reference], val basedOn: LitSeq[Reference], val subject: Option[Reference], val language: Option[LANGUAGES], val authored: Option[FHIRDateTime], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: Option[Identifier], val implicitRules: Option[UriStr], val questionnaire: Option[Canonical], val modifierExtension: LitSeq[Extension], val item: LitSeq[Item], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.

A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
author
  • Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
authored
  • The date and/or time that this set of answers were last changed.
basedOn
  • The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
encounter
  • The Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A business identifier assigned to a particular completed (or partially completed) questionnaire.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
item
  • A group or question item from the original questionnaire for which answers are provided.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
partOf
  • A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.
questionnaire
  • The Questionnaire that defines and organizes the questions for which answers are being provided.
source
  • The person who answered the questions about the subject.
status
  • The position of the questionnaire response within its overall lifecycle.
subject
  • The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields partOf, status, author, source, basedOn, subject, authored, encounter, identifier, questionnaire, item.

Companion:
object
object RelatedPerson extends CompanionFor[RelatedPerson]
Companion:
class
@POJOBoilerplate
class RelatedPerson(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val name: LitSeq[HumanName], val photo: LitSeq[Attachment], val active: Option[Boolean], val gender: Option[ADMINISTRATIVE_GENDER], val period: Option[Period], val patient: Reference, val telecom: LitSeq[ContactPoint], val address: LitSeq[Address], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val birthDate: Option[FHIRDate], val identifier: LitSeq[Identifier], val relationship: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val communication: LitSeq[Communication], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
active
  • Whether this related person record is in active use.
address
  • Address where the related person can be contacted or visited.
birthDate
  • The date on which the related person was born.
communication
  • A language which may be used to communicate with about the patient's health.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
gender
  • Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifier for a person within a particular scope.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A name associated with the person.
patient
  • The patient this person is related to.
period
  • The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
photo
  • Image of the person.
relationship
  • The nature of the relationship between a patient and the related person.
telecom
  • A contact detail for the person, e.g. a telephone number or an email address.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields name, photo, active, gender, period, patient, telecom, address, birthDate, identifier, relationship, communication.

Companion:
object
object RequestGroup extends CompanionFor[RequestGroup]
Companion:
class
@POJOBoilerplate
class RequestGroup(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val note: LitSeq[Annotation], val status: REQUEST_STATUS, val intent: REQUEST_INTENT, val author: Option[Reference], val basedOn: LitSeq[Reference], val subject: Option[Reference], val language: Option[LANGUAGES], val replaces: LitSeq[Reference], val priority: Option[REQUEST_PRIORITY], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val authoredOn: Option[FHIRDateTime], val reasonCode: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val instantiatesUri: LitSeq[UriStr], val groupIdentifier: Option[Identifier], val reasonReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val instantiatesCanonical: LitSeq[Canonical], val action: LitSeq[Action], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".

A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
action
  • The actions, if any, produced by the evaluation of the artifact.
author
  • Provides a reference to the author of the request group.
authoredOn
  • Indicates when the request group was created.
basedOn
  • A plan, proposal or order that is fulfilled in whole or in part by this request.
code
  • A code that identifies what the overall request group is.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
encounter
  • Describes the context of the request group, if any.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
groupIdentifier
  • A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Allows a service to provide a unique, business identifier for the request.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
instantiatesCanonical
  • A canonical URL referencing a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
instantiatesUri
  • A URL referencing an externally defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
intent
  • Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Provides a mechanism to communicate additional information about the response.
priority
  • Indicates how quickly the request should be addressed with respect to other requests.
reasonCode
  • Describes the reason for the request group in coded or textual form.
reasonReference
  • Indicates another resource whose existence justifies this request group.
replaces
  • Completed or terminated request(s) whose function is taken by this new request.
status
  • The current state of the request. For request groups, the status reflects the status of all the requests in the group.
subject
  • The subject for which the request group was created.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, note, status, intent, author, basedOn, subject, replaces, priority, encounter, identifier, authoredOn, reasonCode, instantiatesUri, groupIdentifier, reasonReference, instantiatesCanonical, action.

Companion:
object
object ResearchDefinition extends CompanionFor[ResearchDefinition]
Companion:
class
@POJOBoilerplate
class ResearchDefinition(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], val title: Option[String], val usage: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val version: Option[String], val contact: LitSeq[ContactDetail], val comment: LitSeq[String], val purpose: Option[Markdown], val library: LitSeq[Canonical], val outcome: Option[Reference], val language: Option[LANGUAGES], val subtitle: Option[String], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val exposure: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val shortTitle: Option[String], val subject: Option[SubjectChoice], val useContext: LitSeq[UsageContext], val population: Reference, val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val modifierExtension: LitSeq[Extension], val exposureAlternative: Option[Reference], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.

The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
comment
  • A human-readable string to clarify or explain concepts about the resource.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.
date
  • The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes.
description
  • A free text natural language description of the research definition from a consumer's perspective.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectivePeriod
  • The period during which the research definition content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
experimental
  • A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
exposure
  • A reference to a ResearchElementDefinition resource that defines the exposure for the research.
exposureAlternative
  • A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the research definition is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
library
  • A reference to a Library resource containing the formal logic used by the ResearchDefinition.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
outcome
  • A reference to a ResearchElementDefinition resomece that defines the outcome for the research.
population
  • A reference to a ResearchElementDefinition resource that defines the population for the research.
publisher
  • The name of the organization or individual that published the research definition.
purpose
  • Explanation of why this research definition is needed and why it has been designed as it has.
relatedArtifact
  • Related artifacts such as additional documentation, justification, or bibliographic references.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
shortTitle
  • The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
status
  • The status of this research definition. Enables tracking the life-cycle of the content.
subject
  • The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.
subtitle
  • An explanatory or alternate title for the ResearchDefinition giving additional information about its content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the research definition.
topic
  • Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching.
url
  • An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers.
usage
  • A detailed description, from a clinical perspective, of how the ResearchDefinition is used.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research definition instances.
version
  • The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
Constructor:

Introduces the fields url, name, date, title, usage, topic, status, author, editor, version, contact, comment, purpose, library, outcome, subtitle, reviewer, endorser, exposure, publisher, copyright, identifier, shortTitle, subject, useContext, population, description, experimental, jurisdiction, approvalDate, lastReviewDate, effectivePeriod, relatedArtifact, exposureAlternative.

Companion:
object
Companion:
class
@POJOBoilerplate
class ResearchElementDefinition(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], `type`: RESEARCH_ELEMENT_TYPE, val title: Option[String], val usage: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val version: Option[String], val contact: LitSeq[ContactDetail], val comment: LitSeq[String], val purpose: Option[Markdown], val library: LitSeq[Canonical], val language: Option[LANGUAGES], val subtitle: Option[String], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val shortTitle: Option[String], val subject: Option[SubjectChoice], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val variableType: Option[VARIABLE_TYPE], val implicitRules: Option[UriStr], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val modifierExtension: LitSeq[Extension], val characteristic: NonEmptyLitSeq[Characteristic], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

The ResearchElementDefinition resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The type of research element, a population, an exposure, or an outcome.
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
characteristic
  • A characteristic that defines the members of the research element. Multiple characteristics are applied with "and" semantics.
comment
  • A human-readable string to clarify or explain concepts about the resource.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the research element definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research element definition.
date
  • The date (and optionally time) when the research element definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research element definition changes.
description
  • A free text natural language description of the research element definition from a consumer's perspective.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectivePeriod
  • The period during which the research element definition content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
experimental
  • A Boolean value to indicate that this research element definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this research element definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the research element definition is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
library
  • A reference to a Library resource containing the formal logic used by the ResearchElementDefinition.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the research element definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the research element definition.
purpose
  • Explanation of why this research element definition is needed and why it has been designed as it has.
relatedArtifact
  • Related artifacts such as additional documentation, justification, or bibliographic references.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
shortTitle
  • The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
status
  • The status of this research element definition. Enables tracking the life-cycle of the content.
subject
  • The intended subjects for the ResearchElementDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchElementDefinition can be anything.
subtitle
  • An explanatory or alternate title for the ResearchElementDefinition giving additional information about its content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the research element definition.
topic
  • Descriptive topics related to the content of the ResearchElementDefinition. Topics provide a high-level categorization grouping types of ResearchElementDefinitions that can be useful for filtering and searching.
url
  • An absolute URI that is used to identify this research element definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research element definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research element definition is stored on different servers.
usage
  • A detailed description, from a clinical perspective, of how the ResearchElementDefinition is used.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research element definition instances.
variableType
  • The type of the outcome (e.g. Dichotomous, Continuous, or Descriptive).
version
  • The identifier that is used to identify this version of the research element definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research element definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
Constructor:

Introduces the fields url, name, date, type, title, usage, topic, status, author, editor, version, contact, comment, purpose, library, subtitle, reviewer, endorser, publisher, copyright, identifier, shortTitle, subject, useContext, description, experimental, jurisdiction, approvalDate, variableType, lastReviewDate, effectivePeriod, relatedArtifact, characteristic.

Companion:
object
object ResearchStudy extends CompanionFor[ResearchStudy]
Companion:
class
@POJOBoilerplate
class ResearchStudy(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val site: LitSeq[Reference], val note: LitSeq[Annotation], val title: Option[String], val phase: Option[CodeableConcept], val focus: LitSeq[CodeableConcept], val partOf: LitSeq[Reference], val status: RESEARCH_STUDY_STATUS, val period: Option[Period], val contact: LitSeq[ContactDetail], val keyword: LitSeq[CodeableConcept], val sponsor: Option[Reference], val language: Option[LANGUAGES], val protocol: LitSeq[Reference], val category: LitSeq[CodeableConcept], val location: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val condition: LitSeq[CodeableConcept], val identifier: LitSeq[Identifier], val enrollment: LitSeq[Reference], val description: Option[Markdown], val implicitRules: Option[UriStr], val reasonStopped: Option[CodeableConcept], val relatedArtifact: LitSeq[RelatedArtifact], val modifierExtension: LitSeq[Extension], val primaryPurposeType: Option[CodeableConcept], val principalInvestigator: Option[Reference], val arm: LitSeq[Arm], val objective: LitSeq[Objective], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.

A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
arm
  • Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
category
  • Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
condition
  • The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.
contact
  • Contact details to assist a user in learning more about or engaging with the study.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
description
  • A full description of how the study is being conducted.
enrollment
  • Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
focus
  • The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers assigned to this research study by the sponsor or other systems.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
keyword
  • Key terms to aid in searching for or filtering the study.
language
  • The base language in which the resource is written.
location
  • Indicates a country, state or other region where the study is taking place.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Comments made about the study by the performer, subject or other participants.
objective
  • A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.
partOf
  • A larger research study of which this particular study is a component or step.
period
  • Identifies the start date and the expected (or actual, depending on status) end date for the study.
phase
  • The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.
primaryPurposeType
  • The type of study based upon the intent of the study's activities. A classification of the intent of the study.
principalInvestigator
  • A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.
protocol
  • The set of steps expected to be performed as part of the execution of the study.
reasonStopped
  • A description and/or code explaining the premature termination of the study.
relatedArtifact
  • Citations, references and other related documents.
site
  • A facility in which study activities are conducted.
sponsor
  • An organization that initiates the investigation and is legally responsible for the study.
status
  • The current state of the study.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive user-friendly label for the study.
Constructor:

Introduces the fields site, note, title, phase, focus, partOf, status, period, contact, keyword, sponsor, protocol, category, location, condition, identifier, enrollment, description, reasonStopped, relatedArtifact, primaryPurposeType, principalInvestigator, arm, objective.

Companion:
object
object ResearchSubject extends CompanionFor[ResearchSubject]
Companion:
class
@POJOBoilerplate
class ResearchSubject(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val study: Reference, val status: RESEARCH_SUBJECT_STATUS, val period: Option[Period], val consent: Option[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val actualArm: Option[String], val identifier: LitSeq[Identifier], val individual: Reference, val assignedArm: Option[String], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A physical entity which is the primary unit of operational and/or administrative interest in a study.

A physical entity which is the primary unit of operational and/or administrative interest in a study.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
actualArm
  • The name of the arm in the study the subject actually followed as part of this study.
assignedArm
  • The name of the arm in the study the subject is expected to follow as part of this study.
consent
  • A record of the patient's informed agreement to participate in the study.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers assigned to this research subject for a study.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
individual
  • The record of the person or animal who is involved in the study.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
period
  • The dates the subject began and ended their participation in the study.
status
  • The current state of the subject.
study
  • Reference to the study the subject is participating in.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields study, status, period, consent, actualArm, identifier, individual, assignedArm.

Companion:
object
object RiskAssessment extends CompanionFor[RiskAssessment]
Companion:
class
@POJOBoilerplate
class RiskAssessment(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val note: LitSeq[Annotation], val basis: LitSeq[Reference], val parent: Option[Reference], val status: OBSERVATION_STATUS, val method: Option[CodeableConcept], val basedOn: Option[Reference], val subject: Reference, val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val condition: Option[Reference], val performer: Option[Reference], val identifier: LitSeq[Identifier], val reasonCode: LitSeq[CodeableConcept], val mitigation: Option[String], val implicitRules: Option[UriStr], val occurrence: Option[OccurrenceChoice], val reasonReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val prediction: LitSeq[Prediction], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
basedOn
  • A reference to the request that is fulfilled by this risk assessment.
basis
  • Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).
code
  • The type of the risk assessment performed.
condition
  • For assessments or prognosis specific to a particular condition, indicates the condition being assessed.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
encounter
  • The encounter where the assessment was performed.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifier assigned to the risk assessment.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
method
  • The algorithm, process or mechanism used to evaluate the risk.
mitigation
  • A description of the steps that might be taken to reduce the identified risk(s).
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Additional comments about the risk assessment.
occurrence
  • The date (and possibly time) the risk assessment was performed.
parent
  • A reference to a resource that this risk assessment is part of, such as a Procedure.
performer
  • The provider or software application that performed the assessment.
prediction
  • Describes the expected outcome for the subject.
reasonCode
  • The reason the risk assessment was performed.
reasonReference
  • Resources supporting the reason the risk assessment was performed.
status
  • The status of the RiskAssessment, using the same statuses as an Observation.
subject
  • The patient or group the risk assessment applies to.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, note, basis, parent, status, method, basedOn, subject, encounter, condition, performer, identifier, reasonCode, mitigation, occurrence, reasonReference, prediction.

Companion:
object
object RiskEvidenceSynthesis extends CompanionFor[RiskEvidenceSynthesis]
Companion:
class
@POJOBoilerplate
class RiskEvidenceSynthesis(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], val note: LitSeq[Annotation], val title: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val version: Option[String], val contact: LitSeq[ContactDetail], val outcome: Reference, val language: Option[LANGUAGES], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val exposure: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val studyType: Option[CodeableConcept], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], val population: Reference, val description: Option[Markdown], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val synthesisType: Option[CodeableConcept], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val modifierExtension: LitSeq[Extension], val sampleSize: Option[SampleSize], val riskEstimate: Option[RiskEstimate], val certainty: LitSeq[Certainty], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.

The RiskEvidenceSynthesis resource describes the likelihood of an outcome in a population plus exposure state where the risk estimate is derived from a combination of research studies.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
certainty
  • A description of the certainty of the risk estimate.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the risk evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the risk evidence synthesis.
date
  • The date (and optionally time) when the risk evidence synthesis was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the risk evidence synthesis changes.
description
  • A free text natural language description of the risk evidence synthesis from a consumer's perspective.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectivePeriod
  • The period during which the risk evidence synthesis content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
exposure
  • A reference to a EvidenceVariable resource that defines the exposure for the research.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this risk evidence synthesis when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the risk evidence synthesis is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the risk evidence synthesis. This name should be usable as an identifier for the module by machine processing applications such as code generation.
note
  • A human-readable string to clarify or explain concepts about the resource.
outcome
  • A reference to a EvidenceVariable resomece that defines the outcome for the research.
population
  • A reference to a EvidenceVariable resource that defines the population for the research.
publisher
  • The name of the organization or individual that published the risk evidence synthesis.
relatedArtifact
  • Related artifacts such as additional documentation, justification, or bibliographic references.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
riskEstimate
  • The estimated risk of the outcome.
sampleSize
  • A description of the size of the sample involved in the synthesis.
status
  • The status of this risk evidence synthesis. Enables tracking the life-cycle of the content.
studyType
  • Type of study eg randomized trial.
synthesisType
  • Type of synthesis eg meta-analysis.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the risk evidence synthesis.
topic
  • Descriptive topics related to the content of the RiskEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.
url
  • An absolute URI that is used to identify this risk evidence synthesis when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this risk evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the risk evidence synthesis is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate risk evidence synthesis instances.
version
  • The identifier that is used to identify this version of the risk evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the risk evidence synthesis author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, note, title, topic, status, author, editor, version, contact, outcome, reviewer, endorser, exposure, publisher, copyright, studyType, identifier, useContext, population, description, jurisdiction, approvalDate, synthesisType, lastReviewDate, effectivePeriod, relatedArtifact, sampleSize, riskEstimate, certainty.

Companion:
object
object Schedule extends CompanionFor[Schedule]
Companion:
class
@POJOBoilerplate
class Schedule(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val actor: NonEmptyLitSeq[Reference], val active: Option[Boolean], val comment: Option[String], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val specialty: LitSeq[CodeableConcept], val identifier: LitSeq[Identifier], val serviceType: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val serviceCategory: LitSeq[CodeableConcept], val planningHorizon: Option[Period], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A container for slots of time that may be available for booking appointments.

A container for slots of time that may be available for booking appointments.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
active
  • Whether this schedule record is in active use or should not be used (such as was entered in error).
actor
  • Slots that reference this schedule resource provide the availability details to these referenced resource(s).
comment
  • Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • External Ids for this item.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
planningHorizon
  • The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
serviceCategory
  • A broad categorization of the service that is to be performed during this appointment.
serviceType
  • The specific service that is to be performed during this appointment.
specialty
  • The specialty of a practitioner that would be required to perform the service requested in this appointment.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields actor, active, comment, specialty, identifier, serviceType, serviceCategory, planningHorizon.

Companion:
object
object SearchParameter extends CompanionFor[SearchParameter]
Companion:
class
@POJOBoilerplate
class SearchParameter(val id: Option[String], val url: UriStr, val meta: Option[Meta], val text: Option[Narrative], val name: String, val date: Option[FHIRDateTime], val code: Code, val base: NonEmptyLitSeq[RESOURCE_TYPES], `type`: SEARCH_PARAM_TYPE, val xpath: Option[String], val chain: LitSeq[String], val status: PUBLICATION_STATUS, val target: LitSeq[RESOURCE_TYPES], val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val language: Option[LANGUAGES], val modifier: LitSeq[SEARCH_MODIFIER_CODE], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val useContext: LitSeq[UsageContext], val expression: Option[String], val xpathUsage: Option[SEARCH_XPATH_USAGE], val multipleOr: Option[Boolean], val comparator: LitSeq[SEARCH_COMPARATOR], val derivedFrom: Option[Canonical], val description: Markdown, val multipleAnd: Option[Boolean], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val component: LitSeq[Component], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A search parameter that defines a named search item that can be used to search/filter on a resource.

A search parameter that defines a named search item that can be used to search/filter on a resource.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The type of value that a search parameter may contain, and how the content is interpreted.
base
  • The base resource type(s) that this search parameter can be used against.
chain
  • Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.
code
  • The code used in the URL or the parameter name in a parameters resource for this search parameter.
comparator
  • Comparators supported for the search parameter.
component
  • Used to define the parts of a composite search parameter.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
date
  • The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
derivedFrom
  • Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.
description
  • And how it used.
experimental
  • A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
expression
  • A FHIRPath expression that returns a set of elements for the search parameter.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the search parameter is intended to be used.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifier
  • A modifier supported for the search parameter.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
multipleAnd
  • Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters match.
multipleOr
  • Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values match.
name
  • A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the search parameter.
purpose
  • Explanation of why this search parameter is needed and why it has been designed as it has.
status
  • The status of this search parameter. Enables tracking the life-cycle of the content.
target
  • Types of resource (if a resource is referenced).
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
url
  • An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instances.
version
  • The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
xpath
  • An XPath expression that returns a set of elements for the search parameter.
xpathUsage
  • How the search parameter relates to the set of elements returned by evaluating the xpath query.
Constructor:

Introduces the fields url, name, date, code, base, type, xpath, chain, status, target, version, contact, purpose, modifier, publisher, useContext, expression, xpathUsage, multipleOr, comparator, derivedFrom, description, multipleAnd, experimental, jurisdiction, component.

Companion:
object
object ServiceRequest extends CompanionFor[ServiceRequest]
Companion:
class
@POJOBoilerplate
class ServiceRequest(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val note: LitSeq[Annotation], val status: REQUEST_STATUS, val intent: REQUEST_INTENT, val basedOn: LitSeq[Reference], val subject: Reference, val language: Option[LANGUAGES], val replaces: LitSeq[Reference], val category: LitSeq[CodeableConcept], val priority: Option[REQUEST_PRIORITY], val specimen: LitSeq[Reference], val bodySite: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val requester: Option[Reference], val performer: LitSeq[Reference], val insurance: LitSeq[Reference], val identifier: LitSeq[Identifier], val authoredOn: Option[FHIRDateTime], val reasonCode: LitSeq[CodeableConcept], val requisition: Option[Identifier], val orderDetail: LitSeq[CodeableConcept], val quantity: Option[QuantityChoice], val asNeeded: Option[AsNeededChoice], val doNotPerform: Option[Boolean], val locationCode: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val occurrence: Option[OccurrenceChoice], val performerType: Option[CodeableConcept], val supportingInfo: LitSeq[Reference], val instantiatesUri: LitSeq[UriStr], val reasonReference: LitSeq[Reference], val relevantHistory: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val locationReference: LitSeq[Reference], val patientInstruction: Option[String], val instantiatesCanonical: LitSeq[Canonical], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
asNeeded
  • If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
authoredOn
  • When the request transitioned to being actionable.
basedOn
  • Plan/proposal/order fulfilled by this request.
bodySite
  • Anatomic location where the procedure should be performed. This is the target site.
category
  • A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
code
  • A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
doNotPerform
  • Set this to true if the record is saying that the service/procedure should NOT be performed.
encounter
  • An encounter that provides additional information about the healthcare context in which this request is made.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
instantiatesCanonical
  • The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
instantiatesUri
  • The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
insurance
  • Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
intent
  • Whether the request is a proposal, plan, an original order or a reflex order.
language
  • The base language in which the resource is written.
locationCode
  • The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.
locationReference
  • A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Any other notes and comments made about the service request. For example, internal billing notes.
occurrence
  • The date/time at which the requested service should occur.
orderDetail
  • Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.
patientInstruction
  • Instructions in terms that are understood by the patient or consumer.
performer
  • The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
performerType
  • Desired type of performer for doing the requested service.
priority
  • Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
quantity
  • An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
reasonCode
  • An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInfo.
reasonReference
  • Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in supportingInfo.
relevantHistory
  • Key events in the history of the request.
replaces
  • The request takes the place of the referenced completed or terminated request(s).
requester
  • The individual who initiated the request and has responsibility for its activation.
requisition
  • A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
specimen
  • One or more specimens that the laboratory procedure will use.
status
  • The status of the order.
subject
  • On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
supportingInfo
  • Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, note, status, intent, basedOn, subject, replaces, category, priority, specimen, bodySite, encounter, requester, performer, insurance, identifier, authoredOn, reasonCode, requisition, orderDetail, quantity, asNeeded, doNotPerform, locationCode, occurrence, performerType, supportingInfo, instantiatesUri, reasonReference, relevantHistory, locationReference, patientInstruction, instantiatesCanonical.

Companion:
object
object Shareablecodesystem extends CompanionFor[Shareablecodesystem]
Companion:
class
@POJOBoilerplate
class Shareablecodesystem(val id: Option[String], url: UriStr, val meta: Option[Meta], val text: Option[Narrative], name: String, val date: Option[FHIRDateTime], val title: Option[String], val count: Option[UnsignedInt], val status: PUBLICATION_STATUS, version: String, val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val content: CODESYSTEM_CONTENT_MODE, val language: Option[LANGUAGES], val valueSet: Option[Canonical], val contained: LitSeq[Resource], val extension: LitSeq[Extension], publisher: String, val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], description: Markdown, val supplements: Option[Canonical], experimental: Boolean, val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val caseSensitive: Option[Boolean], val compositional: Option[Boolean], val versionNeeded: Option[Boolean], val hierarchyMeaning: Option[CODESYSTEM_HIERARCHY_MEANING], val modifierExtension: LitSeq[Extension], val filter: LitSeq[Filter], val property: LitSeq[Property], concept: NonEmptyLitSeq[Concept], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends CodeSystem

Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets

Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets

Subclass of hl7.model.CodeSystem (The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.)

Value parameters:
caseSensitive
  • If code comparison is case sensitive when codes within this system are compared to each other.
compositional
  • The code system defines a compositional (post-coordination) grammar.
concept
  • Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
content
  • The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
copyright
  • A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.
count
  • The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.
date
  • The date (and optionally time) when the code system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.
description
  • A free text natural language description of the code system from a consumer's perspective.
experimental
  • A Boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
filter
  • A filter that can be used in a value set compose statement when selecting concepts using a filter.
hierarchyMeaning
  • The meaning of the hierarchy of concepts as represented in this resource.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the code system is intended to be used.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
property
  • A property defines an additional slot through which additional information can be provided about a concept.
publisher
  • The name of the organization or individual that published the code system.
purpose
  • Explanation of why this code system is needed and why it has been designed as it has.
status
  • The date (and optionally time) when the code system resource was created or revised.
supplements
  • The canonical URL of the code system that this code system supplement is adding designations and properties to.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the code system.
url
  • An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in Coding.system.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.
valueSet
  • Canonical reference to the value set that contains the entire code system.
version
  • The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in Coding.version.
versionNeeded
  • This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.
Constructor:

Inherits all params from parent. Requires the following fields which were optional in the parent: url, name, version, publisher, description, experimental, concept.

Companion:
object
object Shareablevalueset extends CompanionFor[Shareablevalueset]
Companion:
class
@POJOBoilerplate
class Shareablevalueset(val id: Option[String], url: UriStr, val meta: Option[Meta], val text: Option[Narrative], name: String, val date: Option[FHIRDateTime], val title: Option[String], val status: PUBLICATION_STATUS, version: String, val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], publisher: String, val immutable: Option[Boolean], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], description: Markdown, experimental: Boolean, val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val expansion: Option[Expansion], val compose: Option[Compose], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends ValueSet

Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets

Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets

Subclass of hl7.model.ValueSet (A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem] definitions and their use in coded elements.)

Value parameters:
compose
  • A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
date
  • The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').
description
  • A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.
expansion
  • A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
experimental
  • A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
immutable
  • If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the value set is intended to be used.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the value set.
purpose
  • Explanation of why this value set is needed and why it has been designed as it has.
status
  • The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the value set.
url
  • An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances.
version
  • The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Inherits all params from parent. Requires the following fields which were optional in the parent: url, name, version, publisher, description, experimental.

Companion:
object
object SimpleQuantity extends CompanionFor[SimpleQuantity]
Companion:
class
@POJOBoilerplate
class SimpleQuantity(val id: Option[String], val unit: Option[String], val code: Option[Code], val value: Option[BigDecimal], val system: Option[UriStr], val extension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Quantity

A fixed quantity (no comparator)

A fixed quantity (no comparator)

Subclass of core.model.Quantity (Base StructureDefinition for Quantity Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.)

Value parameters:
code
  • A computer processable form of the unit in some unit representation system.
extension
  • May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
system
  • The identification of the system that provides the coded form of the unit.
unit
  • A human-readable form of the unit.
value
  • The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Constructor:

Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: comparator.

Companion:
object
object Slot extends CompanionFor[Slot]
Companion:
class
@POJOBoilerplate
class Slot(val id: Option[String], val end: ZonedDateTime, val meta: Option[Meta], val text: Option[Narrative], val start: ZonedDateTime, val status: SLOTSTATUS, val comment: Option[String], val language: Option[LANGUAGES], val schedule: Reference, val contained: LitSeq[Resource], val extension: LitSeq[Extension], val specialty: LitSeq[CodeableConcept], val identifier: LitSeq[Identifier], val overbooked: Option[Boolean], val serviceType: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val serviceCategory: LitSeq[CodeableConcept], val appointmentType: Option[CodeableConcept], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A slot of time on a schedule that may be available for booking appointments.

A slot of time on a schedule that may be available for booking appointments.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
appointmentType
  • The style of appointment or patient that may be booked in the slot (not service type).
comment
  • Comments on the slot to describe any extended information. Such as custom constraints on the slot.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
end
  • Date/Time that the slot is to conclude.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • External Ids for this item.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
overbooked
  • This slot has already been overbooked, appointments are unlikely to be accepted for this time.
schedule
  • The schedule resource that this slot defines an interval of status information.
serviceCategory
  • A broad categorization of the service that is to be performed during this appointment.
serviceType
  • 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.
specialty
  • The specialty of a practitioner that would be required to perform the service requested in this appointment.
start
  • Date/Time that the slot is to begin.
status
  • busy | free | busy-unavailable | busy-tentative | entered-in-error.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields end, start, status, comment, schedule, specialty, identifier, overbooked, serviceType, serviceCategory, appointmentType.

Companion:
object
object Specimen extends CompanionFor[Specimen]
Companion:
class
@POJOBoilerplate
class Specimen(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val note: LitSeq[Annotation], val status: Option[SPECIMEN_STATUS], val parent: LitSeq[Reference], val subject: Option[Reference], val request: LitSeq[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val condition: LitSeq[CodeableConcept], val identifier: LitSeq[Identifier], val receivedTime: Option[FHIRDateTime], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val accessionIdentifier: Option[Identifier], val container: LitSeq[Container], val collection: Option[Collection], val processing: LitSeq[Processing], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A sample to be used for analysis.

A sample to be used for analysis.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • The kind of material that forms the specimen.
accessionIdentifier
  • The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
collection
  • Details concerning the specimen collection.
condition
  • A mode or state of being that describes the nature of the specimen.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
container
  • The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Id for specimen.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
parent
  • Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
processing
  • Details concerning processing and processing steps for the specimen.
receivedTime
  • Time when specimen was received for processing or testing.
request
  • Details concerning a service request that required a specimen to be collected.
status
  • The availability of the specimen.
subject
  • 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.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, note, status, parent, subject, request, condition, identifier, receivedTime, accessionIdentifier, container, collection, processing.

Companion:
object
object SpecimenDefinition extends CompanionFor[SpecimenDefinition]
Companion:
class
@POJOBoilerplate
class SpecimenDefinition(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: Option[Identifier], val timeAspect: Option[String], val collection: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val typeCollected: Option[CodeableConcept], val modifierExtension: LitSeq[Extension], val patientPreparation: LitSeq[CodeableConcept], val typeTested: LitSeq[TypeTested], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A kind of specimen with associated set of requirements.

A kind of specimen with associated set of requirements.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
collection
  • The action to be performed for collecting the specimen.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A business identifier associated with the kind of specimen.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
patientPreparation
  • Preparation of the patient for specimen collection.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
timeAspect
  • Time aspect of specimen collection (duration or offset).
typeCollected
  • The kind of material to be collected.
typeTested
  • Specimen conditioned in a container as expected by the testing laboratory.
Constructor:

Introduces the fields identifier, timeAspect, collection, typeCollected, patientPreparation, typeTested.

Companion:
object
object StructureDefinition extends CompanionFor[StructureDefinition]
Companion:
class
@POJOBoilerplate
class StructureDefinition(val id: Option[String], val url: UriStr, val meta: Option[Meta], val text: Option[Narrative], val name: String, val date: Option[FHIRDateTime], val kind: STRUCTURE_DEFINITION_KIND, `type`: UriStr, val title: Option[String], val status: PUBLICATION_STATUS, val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val keyword: LitSeq[Coding], val language: Option[LANGUAGES], `abstract`: Boolean, val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], val derivation: Option[TYPE_DERIVATION_RULE], val description: Option[Markdown], val fhirVersion: Option[FHIR_VERSION], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val baseDefinition: Option[Canonical], val contextInvariant: LitSeq[String], val modifierExtension: LitSeq[Extension], val mapping: LitSeq[Mapping], val context: LitSeq[Context], val snapshot: Option[Snapshot], val differential: Option[Differential], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.

A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`abstract`
  • Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.
`type`
  • The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.
baseDefinition
  • An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
context
  • Identifies the types of resource or data type elements to which the extension can be applied.
contextInvariant
  • A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.
copyright
  • A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.
date
  • The date (and optionally time) when the structure definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes.
derivation
  • How the type relates to the baseDefinition.
description
  • A free text natural language description of the structure definition from a consumer's perspective.
differential
  • A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.
experimental
  • A Boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
fhirVersion
  • The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the structure definition is intended to be used.
keyword
  • A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.
kind
  • Defines the kind of structure that this definition is describing.
language
  • The base language in which the resource is written.
mapping
  • An external specification that the content is mapped to.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the structure definition.
purpose
  • Explanation of why this structure definition is needed and why it has been designed as it has.
snapshot
  • A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.
status
  • The status of this structure definition. Enables tracking the life-cycle of the content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the structure definition.
url
  • An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure definition instances.
version
  • The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, kind, type, title, status, version, contact, purpose, keyword, abstract, publisher, copyright, identifier, useContext, derivation, description, fhirVersion, experimental, jurisdiction, baseDefinition, contextInvariant, mapping, context, snapshot, differential.

Companion:
object
object StructureMap extends CompanionFor[StructureMap]
Companion:
class
@POJOBoilerplate
class StructureMap(val id: Option[String], val url: UriStr, val meta: Option[Meta], val text: Option[Narrative], val name: String, val date: Option[FHIRDateTime], val title: Option[String], val status: PUBLICATION_STATUS, `import`: LitSeq[Canonical], val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val structure: LitSeq[Structure], val group: NonEmptyLitSeq[Group], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A Map of relationships between 2 structures that can be used to transform data.

A Map of relationships between 2 structures that can be used to transform data.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`import`
  • Other maps used by this map (canonical URLs).
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.
date
  • The date (and optionally time) when the structure map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.
description
  • A free text natural language description of the structure map from a consumer's perspective.
experimental
  • A Boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
group
  • Organizes the mapping into manageable chunks for human review/ease of maintenance.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the structure map is intended to be used.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the structure map.
purpose
  • Explanation of why this structure map is needed and why it has been designed as it has.
status
  • The status of this structure map. Enables tracking the life-cycle of the content.
structure
  • A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the structure map.
url
  • An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate structure map instances.
version
  • The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, title, status, import, version, contact, purpose, publisher, copyright, identifier, useContext, description, experimental, jurisdiction, structure, group.

Companion:
object
object Subscription extends CompanionFor[Subscription]
Companion:
class
@POJOBoilerplate
class Subscription(val id: Option[String], val end: Option[ZonedDateTime], val meta: Option[Meta], val text: Option[Narrative], val error: Option[String], val status: SUBSCRIPTION_STATUS, val reason: String, val contact: LitSeq[ContactPoint], val language: Option[LANGUAGES], val criteria: String, val contained: LitSeq[Resource], val extension: LitSeq[Extension], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val channel: Channel, val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.

The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
channel
  • Details where to send notifications when resources are received that meet the criteria.
contact
  • Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
criteria
  • The rules that the server should use to determine when to generate notifications for this subscription.
end
  • The time for the server to turn the subscription off.
error
  • A record of the last error that occurred when the server processed a notification.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
reason
  • A description of why this subscription is defined.
status
  • The status of the subscription, which marks the server state for managing the subscription.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields end, error, status, reason, contact, criteria, channel.

Companion:
object
object Substance extends CompanionFor[Substance]
Companion:
class
@POJOBoilerplate
class Substance(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val code: CodeableConcept, val status: Option[SUBSTANCE_STATUS], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val description: Option[String], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val instance: LitSeq[Instance], val ingredient: LitSeq[Ingredient], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A homogeneous material with a definite composition.

A homogeneous material with a definite composition.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
category
  • A code that classifies the general type of substance. This is used for searching, sorting and display purposes.
code
  • A code (or set of codes) that identify this substance.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
description
  • A description of the substance - its appearance, handling requirements, and other usage notes.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Unique identifier for the substance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
ingredient
  • A substance can be composed of other substances.
instance
  • Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
status
  • A code to indicate if the substance is actively used.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields code, status, category, identifier, description, instance, ingredient.

Companion:
object
object SubstancePolymer extends CompanionFor[SubstancePolymer]
Companion:
class
@POJOBoilerplate
class SubstancePolymer(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `class`: Option[CodeableConcept], val language: Option[LANGUAGES], val geometry: Option[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val modification: LitSeq[String], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val copolymerConnectivity: LitSeq[CodeableConcept], val monomerSet: LitSeq[MonomerSet], val repeat: LitSeq[Repeat], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Todo.

Todo.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`class`
  • Todo.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copolymerConnectivity
  • Todo.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
geometry
  • Todo.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modification
  • Todo.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
monomerSet
  • Todo.
repeat
  • Todo.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields class, geometry, modification, copolymerConnectivity, monomerSet, repeat.

Companion:
object
@POJOBoilerplate
class SubstanceReferenceInformation(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val comment: Option[String], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val gene: LitSeq[Gene], val target: LitSeq[Target], val geneElement: LitSeq[GeneElement], val classification: LitSeq[Classification], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Todo.

Todo.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
classification
  • Todo.
comment
  • Todo.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
gene
  • Todo.
geneElement
  • Todo.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
target
  • Todo.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields comment, gene, target, geneElement, classification.

Companion:
object
object SubstanceSpecification extends CompanionFor[SubstanceSpecification]
Companion:
class
@POJOBoilerplate
class SubstanceSpecification(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val status: Option[CodeableConcept], val domain: Option[CodeableConcept], val source: LitSeq[Reference], val comment: Option[String], val polymer: Option[Reference], val protein: Option[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: Option[Identifier], val description: Option[String], val nucleicAcid: Option[Reference], val implicitRules: Option[UriStr], val sourceMaterial: Option[Reference], val molecularWeight: LitSeq[MolecularWeight], val modifierExtension: LitSeq[Extension], val referenceInformation: Option[Reference], val code: LitSeq[Code], val moiety: LitSeq[Moiety], val property: LitSeq[Property], val name: LitSeq[Name], val relationship: LitSeq[Relationship], val structure: Option[Structure], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

The detailed description of a substance, typically at a level beyond what is used for prescribing.

The detailed description of a substance, typically at a level beyond what is used for prescribing.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • High level categorization, e.g. polymer or nucleic acid.
code
  • Codes associated with the substance.
comment
  • Textual comment about this record of a substance.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
description
  • Textual description of the substance.
domain
  • If the substance applies to only human or veterinary use.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifier by which this substance is known.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
moiety
  • Moiety, for structural modifications.
molecularWeight
  • The molecular weight or weight range (for proteins, polymers or nucleic acids).
name
  • Names applicable to this substance.
nucleicAcid
  • Data items specific to nucleic acids.
polymer
  • Data items specific to polymers.
property
  • General specifications for this substance, including how it is related to other substances.
protein
  • Data items specific to proteins.
referenceInformation
  • General information detailing this substance.
relationship
  • A link between this substance and another, with details of the relationship.
source
  • Supporting literature.
sourceMaterial
  • Material or taxonomic/anatomical source for the substance.
status
  • Status of substance within the catalogue e.g. approved.
structure
  • Structural information.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, status, domain, source, comment, polymer, protein, identifier, description, nucleicAcid, sourceMaterial, molecularWeight, referenceInformation, code, moiety, property, name, relationship, structure.

Companion:
object
object SupplyDelivery extends CompanionFor[SupplyDelivery]
Companion:
class
@POJOBoilerplate
class SupplyDelivery(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], `type`: Option[CodeableConcept], val partOf: LitSeq[Reference], val status: Option[SUPPLYDELIVERY_STATUS], val basedOn: LitSeq[Reference], val patient: Option[Reference], val language: Option[LANGUAGES], val supplier: Option[Reference], val receiver: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: LitSeq[Identifier], val destination: Option[Reference], val implicitRules: Option[UriStr], val occurrence: Option[OccurrenceChoice], val modifierExtension: LitSeq[Extension], val suppliedItem: Option[SuppliedItem], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Record of delivery of what is supplied.

Record of delivery of what is supplied.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`type`
  • Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
basedOn
  • A plan, proposal or order that is fulfilled in whole or in part by this event.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
destination
  • Identification of the facility/location where the Supply was shipped to, as part of the dispense event.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifier for the supply delivery event that is used to identify it across multiple disparate systems.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
occurrence
  • The date or time(s) the activity occurred.
partOf
  • A larger event of which this particular event is a component or step.
patient
  • A link to a resource representing the person whom the delivered item is for.
receiver
  • Identifies the person who picked up the Supply.
status
  • A code specifying the state of the dispense event.
suppliedItem
  • The item that is being delivered or has been supplied.
supplier
  • The individual responsible for dispensing the medication, supplier or device.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields type, partOf, status, basedOn, patient, supplier, receiver, identifier, destination, occurrence, suppliedItem.

Companion:
object
object SupplyRequest extends CompanionFor[SupplyRequest]
Companion:
class
@POJOBoilerplate
class SupplyRequest(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val status: Option[SUPPLYREQUEST_STATUS], val item: ItemChoice, val language: Option[LANGUAGES], val category: Option[CodeableConcept], val priority: Option[REQUEST_PRIORITY], val quantity: Quantity, val supplier: LitSeq[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val requester: Option[Reference], val deliverTo: Option[Reference], val identifier: LitSeq[Identifier], val authoredOn: Option[FHIRDateTime], val reasonCode: LitSeq[CodeableConcept], val deliverFrom: Option[Reference], val implicitRules: Option[UriStr], val occurrence: Option[OccurrenceChoice], val reasonReference: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val parameter: LitSeq[Parameter], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A record of a request for a medication, substance or device used in the healthcare setting.

A record of a request for a medication, substance or device used in the healthcare setting.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
authoredOn
  • When the request was made.
category
  • Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
deliverFrom
  • Where the supply is expected to come from.
deliverTo
  • Where the supply is destined to go.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Business identifiers assigned to this SupplyRequest by the author and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
item
  • The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
occurrence
  • When the request should be fulfilled.
parameter
  • Specific parameters for the ordered item. For example, the size of the indicated item.
priority
  • Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
quantity
  • The amount that is being ordered of the indicated item.
reasonCode
  • The reason why the supply item was requested.
reasonReference
  • The reason why the supply item was requested.
requester
  • The device, practitioner, etc. who initiated the request.
status
  • Status of the supply request.
supplier
  • Who is intended to fulfill the request.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields status, item, category, priority, quantity, supplier, requester, deliverTo, identifier, authoredOn, reasonCode, deliverFrom, occurrence, reasonReference, parameter.

Companion:
object
object Task extends CompanionFor[Task]
Companion:
class
@POJOBoilerplate
class Task(val id: Option[String], `for`: Option[Reference], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val note: LitSeq[Annotation], val focus: Option[Reference], val owner: Option[Reference], val partOf: LitSeq[Reference], val status: TASK_STATUS, val intent: TASK_INTENT, val basedOn: LitSeq[Reference], val language: Option[LANGUAGES], val priority: Option[REQUEST_PRIORITY], val location: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val requester: Option[Reference], val insurance: LitSeq[Reference], val identifier: LitSeq[Identifier], val authoredOn: Option[FHIRDateTime], val reasonCode: Option[CodeableConcept], val description: Option[String], val statusReason: Option[CodeableConcept], val lastModified: Option[FHIRDateTime], val implicitRules: Option[UriStr], val performerType: LitSeq[CodeableConcept], val businessStatus: Option[CodeableConcept], val instantiatesUri: Option[UriStr], val groupIdentifier: Option[Identifier], val executionPeriod: Option[Period], val reasonReference: Option[Reference], val relevantHistory: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val instantiatesCanonical: Option[Canonical], val input: LitSeq[Input], val output: LitSeq[Output], val restriction: Option[Restriction], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A task to be performed.

A task to be performed.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`for`
  • The entity who benefits from the performance of the service specified in the task (e.g., the patient).
authoredOn
  • The date and time this task was created.
basedOn
  • BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
businessStatus
  • Contains business-specific nuances of the business state.
code
  • A name or code (or both) briefly describing what the task involves.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
description
  • A free-text description of what is to be performed.
encounter
  • The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
executionPeriod
  • Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
focus
  • The request being actioned or the resource being manipulated by this task.
groupIdentifier
  • An identifier that links together multiple tasks and other requests that were created in the same context.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • The business identifier for this task.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
input
  • Additional information that may be needed in the execution of the task.
instantiatesCanonical
  • The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
instantiatesUri
  • The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
insurance
  • Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
intent
  • Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
language
  • The base language in which the resource is written.
lastModified
  • The date and time of last modification to this task.
location
  • Principal physical location where the this task is performed.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Free-text information captured about the task as it progresses.
output
  • Outputs produced by the Task.
owner
  • Individual organization or Device currently responsible for task execution.
partOf
  • Task that this particular task is part of.
performerType
  • The kind of participant that should perform the task.
priority
  • Indicates how quickly the Task should be addressed with respect to other requests.
reasonCode
  • A description or code indicating why this task needs to be performed.
reasonReference
  • A resource reference indicating why this task needs to be performed.
relevantHistory
  • Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
requester
  • The creator of the task.
restriction
  • If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
status
  • The current status of the task.
statusReason
  • An explanation as to why this task is held, failed, was refused, etc.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields for, code, note, focus, owner, partOf, status, intent, basedOn, priority, location, encounter, requester, insurance, identifier, authoredOn, reasonCode, description, statusReason, lastModified, performerType, businessStatus, instantiatesUri, groupIdentifier, executionPeriod, reasonReference, relevantHistory, instantiatesCanonical, input, output, restriction.

Companion:
object
Companion:
class
@POJOBoilerplate
class TerminologyCapabilities(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: FHIRDateTime, val kind: CAPABILITY_STATEMENT_KIND, val title: Option[String], val status: PUBLICATION_STATUS, val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val useContext: LitSeq[UsageContext], val lockedDate: Option[Boolean], val codeSearch: Option[CODE_SEARCH_SUPPORT], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val closure: Option[Closure], val software: Option[Software], val translation: Option[Translation], val validateCode: Option[ValidateCode], val implementation: Option[Implementation], val expansion: Option[Expansion], val codeSystem: LitSeq[CodeSystem], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
closure
  • Whether the $closure operation is supported.
codeSearch
  • The degree to which the server supports the code search parameter on ValueSet, if it is supported.
codeSystem
  • Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.
date
  • The date (and optionally time) when the terminology capabilities was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the terminology capabilities changes.
description
  • A free text natural language description of the terminology capabilities from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
expansion
experimental
  • A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implementation
  • Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the terminology capabilities is intended to be used.
kind
  • The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).
language
  • The base language in which the resource is written.
lockedDate
  • Whether the server supports lockedDate.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the terminology capabilities.
purpose
  • Explanation of why this terminology capabilities is needed and why it has been designed as it has.
software
  • Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.
status
  • The status of this terminology capabilities. Enables tracking the life-cycle of the content.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the terminology capabilities.
translation
url
  • An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate terminology capabilities instances.
validateCode
version
  • The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, kind, title, status, version, contact, purpose, publisher, copyright, useContext, lockedDate, codeSearch, description, experimental, jurisdiction, closure, software, translation, validateCode, implementation, expansion, codeSystem.

Companion:
object
object TestReport extends CompanionFor[TestReport]
Companion:
class
@POJOBoilerplate
class TestReport(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val score: Option[BigDecimal], val status: REPORT_STATUS_CODES, val result: REPORT_RESULT_CODES, val tester: Option[String], val issued: Option[FHIRDateTime], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val identifier: Option[Identifier], val testScript: Reference, val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val participant: LitSeq[Participant], val test: LitSeq[Test], val teardown: Option[Teardown], val setup: Option[Setup], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A summary of information based on the results of executing a TestScript.

A summary of information based on the results of executing a TestScript.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • Identifier for the TestScript assigned for external purposes outside the context of FHIR.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
issued
  • When the TestScript was executed and this TestReport was generated.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A free text natural language name identifying the executed TestScript.
participant
  • A participant in the test execution, either the execution engine, a client, or a server.
result
  • The overall result from the execution of the TestScript.
score
  • The final score (percentage of tests passed) resulting from the execution of the TestScript.
setup
  • The results of the series of required setup operations before the tests were executed.
status
  • The current state of this test report.
teardown
  • The results of the series of operations required to clean up after all the tests were executed (successfully or otherwise).
test
  • A test executed from the test script.
testScript
  • Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the TestScript.url.
tester
  • Name of the tester producing this report (Organization or individual).
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields name, score, status, result, tester, issued, identifier, testScript, participant, test, teardown, setup.

Companion:
object
object TestScript extends CompanionFor[TestScript]
Companion:
class
@POJOBoilerplate
class TestScript(val id: Option[String], val url: UriStr, val meta: Option[Meta], val text: Option[Narrative], val name: String, val date: Option[FHIRDateTime], val title: Option[String], val status: PUBLICATION_STATUS, val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val profile: LitSeq[Reference], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: Option[Identifier], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val origin: LitSeq[Origin], val fixture: LitSeq[Fixture], val variable: LitSeq[Variable], val destination: LitSeq[Destination], val test: LitSeq[Test], val teardown: Option[Teardown], val metadata: Option[Metadata], val setup: Option[Setup], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

A structured set of tests against a FHIR server or client implementation to determine compliance against the FHIR specification.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.
date
  • The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.
description
  • A free text natural language description of the test script from a consumer's perspective.
destination
  • An abstract server used in operations within this test script in the destination element.
experimental
  • A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
fixture
  • Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the test script is intended to be used.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
metadata
  • The required capability must exist and are assumed to function correctly on the FHIR server being tested.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.
origin
  • An abstract server used in operations within this test script in the origin element.
profile
  • Reference to the profile to be used for validation.
publisher
  • The name of the organization or individual that published the test script.
purpose
  • Explanation of why this test script is needed and why it has been designed as it has.
setup
  • A series of required setup operations before tests are executed.
status
  • The status of this test script. Enables tracking the life-cycle of the content.
teardown
  • A series of operations required to clean up after all the tests are executed (successfully or otherwise).
test
  • A test in this script.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the test script.
url
  • An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances.
variable
  • Variable is set based either on element value in response body or on header field value in the response headers.
version
  • The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, title, status, version, contact, purpose, profile, publisher, copyright, identifier, useContext, description, experimental, jurisdiction, origin, fixture, variable, destination, test, teardown, metadata, setup.

Companion:
object
object ValueSet extends CompanionFor[ValueSet]
Companion:
class
@POJOBoilerplate
class ValueSet(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], val date: Option[FHIRDateTime], val title: Option[String], val status: PUBLICATION_STATUS, val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val immutable: Option[Boolean], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val expansion: Option[Expansion], val compose: Option[Compose], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem] definitions and their use in coded elements.

A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem] definitions and their use in coded elements.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
compose
  • A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
copyright
  • A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
date
  • The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').
description
  • A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.
expansion
  • A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
experimental
  • A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
immutable
  • If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the value set is intended to be used.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the value set.
purpose
  • Explanation of why this value set is needed and why it has been designed as it has.
status
  • The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
title
  • A short, descriptive, user-friendly title for the value set.
url
  • An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances.
version
  • The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Constructor:

Introduces the fields url, name, date, title, status, version, contact, purpose, publisher, immutable, copyright, identifier, useContext, description, experimental, jurisdiction, expansion, compose.

Companion:
object
object VerificationResult extends CompanionFor[VerificationResult]
Companion:
class
@POJOBoilerplate
class VerificationResult(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val need: Option[CodeableConcept], val target: LitSeq[Reference], val status: VERIFICATIONRESULT_STATUS, val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val frequency: Option[Timing], val statusDate: Option[FHIRDateTime], val implicitRules: Option[UriStr], val lastPerformed: Option[FHIRDateTime], val nextScheduled: Option[FHIRDate], val failureAction: Option[CodeableConcept], val targetLocation: LitSeq[String], val validationType: Option[CodeableConcept], val modifierExtension: LitSeq[Extension], val validationProcess: LitSeq[CodeableConcept], val validator: LitSeq[Validator], val primarySource: LitSeq[PrimarySource], val attestation: Option[Attestation], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

Describes validation requirements, source(s), status and dates for one or more elements.

Describes validation requirements, source(s), status and dates for one or more elements.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
attestation
  • Information about the entity attesting to information.
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
failureAction
  • The result if validation fails (fatal; warning; record only; none).
frequency
  • Frequency of revalidation.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
lastPerformed
  • The date/time validation was last completed (including failed validations).
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
need
  • The frequency with which the target must be validated (none; initial; periodic).
nextScheduled
  • The date when target is next validated, if appropriate.
primarySource
  • Information about the primary source(s) involved in validation.
status
  • The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).
statusDate
  • When the validation status was updated.
target
  • A resource that was validated.
targetLocation
  • The fhirpath location(s) within the resource that was validated.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
validationProcess
  • The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
validationType
  • What the target is validated against (nothing; primary source; multiple sources).
validator
  • Information about the entity validating information.
Constructor:

Introduces the fields need, target, status, frequency, statusDate, lastPerformed, nextScheduled, failureAction, targetLocation, validationType, validationProcess, validator, primarySource, attestation.

Companion:
object
object VisionPrescription extends CompanionFor[VisionPrescription]
Companion:
class
@POJOBoilerplate
class VisionPrescription(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val status: FM_STATUS, val created: FHIRDateTime, val patient: Reference, val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val identifier: LitSeq[Identifier], val prescriber: Reference, val dateWritten: FHIRDateTime, val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val lensSpecification: NonEmptyLitSeq[LensSpecification], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

An authorization for the provision of glasses and/or contact lenses to a patient.

An authorization for the provision of glasses and/or contact lenses to a patient.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
contained
  • These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
created
  • The date this resource was created.
dateWritten
  • The date (and perhaps time) when the prescription was written.
encounter
  • A reference to a resource that identifies the particular occurrence of contact between patient and health care provider during which the prescription was issued.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A unique identifier assigned to this vision prescription.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language
  • The base language in which the resource is written.
lensSpecification
  • Contain the details of the individual lens specifications and serves as the authorization for the fullfillment by certified professionals.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
patient
  • A resource reference to the person to whom the vision prescription applies.
prescriber
  • The healthcare professional responsible for authorizing the prescription.
status
  • The status of the resource instance.
text
  • A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Constructor:

Introduces the fields status, created, patient, encounter, identifier, prescriber, dateWritten, lensSpecification.

Companion:
object