com.babylonhealth.lit.usbase.model
Type members
Classlikes
Enforces an actual group, rather than a definitional group
Enforces an actual group, rather than a definitional group
Subclass of hl7.model.Group (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.)
- Value Params
- `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.
- 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
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: characteristic.
- Companion
- object
- Companion
- class
- Companion
- class
FHIR Body Mass Index (BMI) Profile
FHIR Body Mass Index (BMI) Profile
Subclass of usbase.model.Vitalsigns (FHIR Vital Signs Profile)
- Value Params
- 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
- Body Mass Index (BMI).
- component
- Used when reporting systolic and diastolic blood pressure.
- 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
- Often just a dateTime for Vital Signs.
- 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
- Used when reporting vital signs panel components.
- 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.
- 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
- 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 thecode
itself specifies the actual focus of the observation.
- 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
- 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
- Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- Constructor
Inherits all params from parent. Refines the types of: value. Requires the following fields which were optional in the parent: value.
- Companion
- object
FHIR Body Height Profile
FHIR Body Height Profile
Subclass of usbase.model.Vitalsigns (FHIR Vital Signs Profile)
- Value Params
- 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
- Body Height.
- component
- Used when reporting systolic and diastolic blood pressure.
- 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
- Often just a dateTime for Vital Signs.
- 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
- Used when reporting vital signs panel components.
- 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.
- 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
- 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 thecode
itself specifies the actual focus of the observation.
- 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
- 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
- Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- Constructor
Inherits all params from parent. Refines the types of: value.
- Companion
- object
FHIR Body Temperature Profile
FHIR Body Temperature Profile
Subclass of usbase.model.Vitalsigns (FHIR Vital Signs Profile)
- Value Params
- 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
- Body Temperature.
- component
- Used when reporting systolic and diastolic blood pressure.
- 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
- Often just a dateTime for Vital Signs.
- 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
- Used when reporting vital signs panel components.
- 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.
- 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
- 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 thecode
itself specifies the actual focus of the observation.
- 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
- 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
- Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- Constructor
Inherits all params from parent. Refines the types of: value.
- Companion
- object
FHIR Body Weight Profile
FHIR Body Weight Profile
Subclass of usbase.model.Vitalsigns (FHIR Vital Signs Profile)
- Value Params
- 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
- Body Weight.
- component
- Used when reporting systolic and diastolic blood pressure.
- 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
- Often just a dateTime for Vital Signs.
- 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
- Used when reporting vital signs panel components.
- 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.
- 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
- 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 thecode
itself specifies the actual focus of the observation.
- 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
- 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
- Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- Constructor
Inherits all params from parent. Refines the types of: value.
- Companion
- object
FHIR Blood Pressure Profile
FHIR Blood Pressure Profile
Subclass of usbase.model.Vitalsigns (FHIR Vital Signs Profile)
- Value Params
- 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
- Blood Pressure.
- component
- Used when reporting systolic and diastolic blood pressure.
- 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
- Often just a dateTime for Vital Signs.
- 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
- Used when reporting vital signs panel components.
- 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.
- 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
- 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 thecode
itself specifies the actual focus of the observation.
- 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
- 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
- Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- Constructor
Inherits all params from parent. Refines the types of: value. Requires the following fields which were optional in the parent: component.
- Companion
- object
- Companion
- class
- Companion
- class
Defines a GuidanceResponse that represents the response container for a CDS Hooks response
Defines a GuidanceResponse that represents the response container for a CDS Hooks response
Subclass of hl7.model.GuidanceResponse (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.)
- Value Params
- 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
- An 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
Inherits all params from parent. Refines the types of: module. Requires the following fields which were optional in the parent: extension, identifier, requestIdentifier.
- Companion
- object
Defines a RequestGroup that can represent a CDS Hooks response
Defines a RequestGroup that can represent a CDS Hooks response
Subclass of hl7.model.RequestGroup (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".)
- Value Params
- 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
Inherits all params from parent. Requires the following fields which were optional in the parent: identifier, instantiatesUri.
- Companion
- object
Defines a PlanDefinition that implements the behavior for a CDS Hooks service
Defines a PlanDefinition that implements the behavior for a CDS Hooks service
Subclass of hl7.model.PlanDefinition (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.)
- Value Params
- `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
- An 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
Inherits all params from parent. Requires the following fields which were optional in the parent: extension.
- Companion
- object
The Clinical Document profile constrains Composition to specify a clinical document (matching CDA). The base Composition is a general resource for compositions or documents about any kind of subject that might be encountered in healthcare including such things as guidelines, medicines, etc. A clinical document is focused on documents related to the provision of care process, where the subject is a patient, a group of patients, or a closely related concept. A clinical document has additional requirements around confidentiality that do not apply in the same way to other kinds of documents.
The Clinical Document profile constrains Composition to specify a clinical document (matching CDA). The base Composition is a general resource for compositions or documents about any kind of subject that might be encountered in healthcare including such things as guidelines, medicines, etc. A clinical document is focused on documents related to the provision of care process, where the subject is a patient, a group of patients, or a closely related concept. A clinical document has additional requirements around confidentiality that do not apply in the same way to other kinds of documents.
Subclass of hl7.model.Composition (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.).)
- Value Params
- `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
- An 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
Inherits all params from parent.
- Companion
- object
Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes.
Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes.
Subclass of core.model.Extension (Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.)
- Value Params
- 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.
- url
- Source of the definition for the extension code - a logical name or a URL.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: value. Hardcodes the value of the following fields: url.
- Companion
- object
- Companion
- class
- Companion
- class
- Companion
- class
Defines a computable PlanDefinition that specifies a single library and requires all expressions referenced from the PlanDefinition to be definitions in that single library
Defines a computable PlanDefinition that specifies a single library and requires all expressions referenced from the PlanDefinition to be definitions in that single library
Subclass of hl7.model.PlanDefinition (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.)
- Value Params
- `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
Inherits all params from parent. Requires the following fields which were optional in the parent: library.
- Companion
- object
The measure criteria that resulted in the resource being included in a particular evaluatedResources bundle.
The measure criteria that resulted in the resource being included in a particular evaluatedResources bundle.
Subclass of core.model.Extension (Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.)
- Value Params
- 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.
- url
- Source of the definition for the extension code - a logical name or a URL.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: value. Hardcodes the value of the following fields: url.
- Companion
- object
A questionnaire with the ability to specify behavior associated with questions or groups of questions
A questionnaire with the ability to specify behavior associated with questions or groups of questions
Subclass of hl7.model.Questionnaire (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.)
- Value Params
- 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
- An 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
Inherits all params from parent.
- Companion
- object
Represents a CQL logic library
Represents a CQL logic library
Subclass of hl7.model.Library (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.)
- Value Params
- `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
Inherits all params from parent.
- Companion
- object
- Companion
- class
- Companion
- class
- Companion
- class
Additional bibliographic reference information about genetics, medications, clinical trials, etc. associated with knowledge-based information on genetics/genetic condition.
Additional bibliographic reference information about genetics, medications, clinical trials, etc. associated with knowledge-based information on genetics/genetic condition.
Subclass of core.model.Extension (Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.)
- Value Params
- 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.
- url
- Source of the definition for the extension code - a logical name or a URL.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: value. Hardcodes the value of the following fields: url.
- Companion
- object
Describes how the DiagnosticReport resource is used to report structured genetic test results
Describes how the DiagnosticReport resource is used to report structured genetic test results
Subclass of hl7.model.DiagnosticReport (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.)
- Value Params
- 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.
- 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
- An 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
- Observations that are part of this diagnostic report.
- 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
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: conclusionCode.
- Companion
- object
Defines the elements to be supported within the AuditEvent resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard
Defines the elements to be supported within the AuditEvent resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard
Subclass of hl7.model.AuditEvent (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.)
- Value Params
- `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
Inherits all params from parent.
- Companion
- object
Defines the elements to be supported within the Provenance resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard
Defines the elements to be supported within the Provenance resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard
Subclass of hl7.model.Provenance (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.)
- Value Params
- 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
Inherits all params from parent.
- Companion
- object
- Companion
- class
Identifies how the ElementDefinition data type is used when it appears within a data element
Identifies how the ElementDefinition data type is used when it appears within a data element
Subclass of hl7.model.ElementDefinition (Base StructureDefinition for ElementDefinition Type: Captures constraints on each element within the resource, profile, or extension.)
- Value Params
- `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.
- 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.
- id
- Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- isModifierReason
- Explains how that element affects the interpretation of the resource or element that contains it.
- 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.
- 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.
- 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.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: short, fixed, isSummary, pattern, isModifier, representation, contentReference, slicing.
- Companion
- object
- Companion
- class
- Companion
- class
- Companion
- class
- Companion
- class
Enforces a descriptive group that can be used in definitional resources
Enforces a descriptive group that can be used in definitional resources
Subclass of hl7.model.Group (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.)
- Value Params
- `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.
- 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
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: member.
- Companion
- object
FHIR Head Circumference Profile
FHIR Head Circumference Profile
Subclass of usbase.model.Vitalsigns (FHIR Vital Signs Profile)
- Value Params
- 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
- Head Circumference.
- component
- Used when reporting systolic and diastolic blood pressure.
- 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
- Often just a dateTime for Vital Signs.
- 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
- Used when reporting vital signs panel components.
- 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.
- 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
- 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 thecode
itself specifies the actual focus of the observation.
- 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
- 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
- Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- Constructor
Inherits all params from parent. Refines the types of: value.
- Companion
- object
FHIR Heart Rate Profile
FHIR Heart Rate Profile
Subclass of usbase.model.Vitalsigns (FHIR Vital Signs Profile)
- Value Params
- 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
- Heart Rate.
- component
- Used when reporting systolic and diastolic blood pressure.
- 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
- Often just a dateTime for Vital Signs.
- 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
- Used when reporting vital signs panel components.
- 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.
- 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
- 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 thecode
itself specifies the actual focus of the observation.
- 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
- 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
- Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- Constructor
Inherits all params from parent. Refines the types of: value.
- Companion
- object
- Companion
- class
glstring.
glstring.
Subclass of core.model.Extension (Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.)
- Value Params
- 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.
- url
- Source of the definition for the extension code - a logical name or a URL.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: value. Hardcodes the value of the following fields: url.
- Companion
- object
haploid.
haploid.
Subclass of core.model.Extension (Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.)
- Value Params
- 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.
- url
- Source of the definition for the extension code - a logical name or a URL.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: value. Hardcodes the value of the following fields: url.
- Companion
- object
Describes how the HLA genotyping results
Describes how the HLA genotyping results
Subclass of hl7.model.DiagnosticReport (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.)
- Value Params
- 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
- An 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
- Observations that are part of this diagnostic report.
- 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
Inherits all params from parent.
- Companion
- object
- Companion
- class
- Companion
- class
- Companion
- class
- Companion
- class
Base StructureDefinition for MarketingStatus Type: The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
Base StructureDefinition for MarketingStatus Type: The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
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 Params
- country
- The country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements.
- dateRange
- The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain.
- 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.
- jurisdiction
- Where a Medicines Regulatory Agency has granted a marketing authorisation for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified.
- 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).
- restoreDate
- The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain.
- status
- This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples.
- Constructor
Introduces the fields status, country, dateRange, restoreDate, jurisdiction.
- Companion
- object
- Companion
- class
Describes how the observation resource is used to report structured genetic test results
Describes how the observation resource is used to report structured genetic test results
Subclass of hl7.model.Observation (Measurements and simple assertions made about a patient, device or other subject.)
- Value Params
- 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
- An 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.
- 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
- 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 thecode
itself specifies the actual focus of the observation.
- 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
- 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
Inherits all params from parent.
- Companion
- object
Allele information.
Allele information.
Subclass of core.model.Extension (Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.)
- Value Params
- 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.
- url
- Source of the definition for the extension code - a logical name or a URL.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: value. Hardcodes the value of the following fields: url.
- Companion
- object
- Companion
- class
AminoAcidChange information.
AminoAcidChange information.
Subclass of core.model.Extension (Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.)
- Value Params
- 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.
- url
- Source of the definition for the extension code - a logical name or a URL.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: value. Hardcodes the value of the following fields: url.
- Companion
- object
- Companion
- class
- Companion
- class
Variant information.
Variant information.
Subclass of core.model.Extension (Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.)
- Value Params
- 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.
- url
- Source of the definition for the extension code - a logical name or a URL.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: value. Hardcodes the value of the following fields: url.
- Companion
- object
FHIR Oxygen Saturation Profile
FHIR Oxygen Saturation Profile
Subclass of usbase.model.Vitalsigns (FHIR Vital Signs Profile)
- Value Params
- 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
- Oxygen Saturation.
- component
- Used when reporting systolic and diastolic blood pressure.
- 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
- Often just a dateTime for Vital Signs.
- 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
- Used when reporting vital signs panel components.
- 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.
- 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
- 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 thecode
itself specifies the actual focus of the observation.
- 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
- 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
- Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- Constructor
Inherits all params from parent. Refines the types of: value.
- Companion
- object
The patient's legal status as citizen of a country.
The patient's legal status as citizen of a country.
Subclass of core.model.Extension (Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.)
- Value Params
- 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.
- url
- Source of the definition for the extension code - a logical name or a URL.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: value. Hardcodes the value of the following fields: url.
- Companion
- object
The nationality of the patient.
The nationality of the patient.
Subclass of core.model.Extension (Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.)
- Value Params
- 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.
- url
- Source of the definition for the extension code - a logical name or a URL.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: value. Hardcodes the value of the following fields: url.
- Companion
- object
Proficiency level of the communication.
Proficiency level of the communication.
Subclass of core.model.Extension (Base StructureDefinition for Extension Type: Optional Extension Element - found in all resources.)
- Value Params
- 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.
- url
- Source of the definition for the extension code - a logical name or a URL.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: value. Hardcodes the value of the following fields: url.
- Companion
- object
Explanation of what this profile contains/is for.
Explanation of what this profile contains/is for.
Subclass of hl7.model.EvidenceVariable (The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.)
- Value Params
- `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
Inherits all params from parent.
- Companion
- object
Base StructureDefinition for Population Type: A populatioof people with some set of grouping criteria.
Base StructureDefinition for Population Type: A populatioof people with some set of grouping criteria.
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 Params
- age
- The age of the specific population.
- 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.
- gender
- The gender of the specific population.
- id
- Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 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).
- physiologicalCondition
- The existing physiological conditions of the specific population to which this applies.
- race
- Race of the specific population.
- Constructor
Introduces the fields race, age, gender, physiologicalCondition.
- Companion
- object
Base StructureDefinition for ProdCharacteristic Type: The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
Base StructureDefinition for ProdCharacteristic Type: The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.
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 Params
- color
- Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
- depth
- Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
- 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.
- externalDiameter
- Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
- height
- Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
- id
- Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- image
- Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.
- imprint
- Where applicable, the imprint can be specified as text.
- 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).
- nominalVolume
- Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
- scoring
- Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
- shape
- Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.
- weight
- Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
- width
- Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
- Constructor
Introduces the fields width, depth, shape, color, image, height, weight, imprint, scoring, nominalVolume, externalDiameter.
- Companion
- object
Base StructureDefinition for ProductShelfLife Type: The shelf-life and storage information for a medicinal product item or container can be described using this class.
Base StructureDefinition for ProductShelfLife Type: The shelf-life and storage information for a medicinal product item or container can be described using this class.
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 Params
- `type`
- This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.
- 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.
- identifier
- Unique identifier for the packaged Medicinal Product.
- 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).
- period
- The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used.
- specialPrecautionsForStorage
- Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified.
- Constructor
Introduces the fields
type
, period, identifier, specialPrecautionsForStorage.- Companion
- object
Guidance on using Provenance for related history elements
Guidance on using Provenance for related history elements
Subclass of hl7.model.Provenance (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.)
- Value Params
- activity
- Indicates what action occurred to the referenced resource.
- agent
- Who was involved with change.
- 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
- This indicates the time the resource action (creation, revision, deletion, etc.) 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
- This points to the version of the resource that was created as a result of this historical record action. Typically only a single resource will be referenced, but if the same action is performed to multiple resources in the context of a transaction, some systems may link multiple resource instances.
- 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
Inherits all params from parent. Refines the types of: occurred. Requires the following fields which were optional in the parent: activity, occurred.
- Companion
- object
- Companion
- class
FHIR Respiratory Rate Profile
FHIR Respiratory Rate Profile
Subclass of usbase.model.Vitalsigns (FHIR Vital Signs Profile)
- Value Params
- 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
- Respiratory Rate.
- component
- Used when reporting systolic and diastolic blood pressure.
- 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
- Often just a dateTime for Vital Signs.
- 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
- Used when reporting vital signs panel components.
- 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.
- 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
- 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 thecode
itself specifies the actual focus of the observation.
- 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
- 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
- Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- Constructor
Inherits all params from parent. Refines the types of: value.
- Companion
- object
Describes how the ServiceRequest resource is used to for genetics
Describes how the ServiceRequest resource is used to for genetics
Subclass of hl7.model.ServiceRequest (A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.)
- Value Params
- 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
- An 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
.
- 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
- reasonReference
- Indicates another resource that provides a justification for why this service is being requested. May relate to the
resources referred to in
supportingInfo
.
- Indicates another resource that provides a justification for why this service is being requested. May relate to the
resources referred to in
- 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
Inherits all params from parent.
- Companion
- object
- Companion
- class
Enforces the minimum information set for the activity definition metadata required by HL7 and other organizations that share and publish activity definitions
Enforces the minimum information set for the activity definition metadata required by HL7 and other organizations that share and publish activity definitions
Subclass of hl7.model.ActivityDefinition (This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.)
- Value Params
- 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
Inherits all params from parent. Requires the following fields which were optional in the parent: url, name, version, publisher, description, experimental.
- Companion
- object
Enforces the minimum information set for the library metadata required by HL7 and other organizations that share and publish libraries
Enforces the minimum information set for the library metadata required by HL7 and other organizations that share and publish libraries
Subclass of hl7.model.Library (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.)
- Value Params
- `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
Inherits all params from parent. Requires the following fields which were optional in the parent: url, name, version, publisher, description, experimental.
- Companion
- object
Enforces the minimum information set for the measure metadata required by HL7 and other organizations that share and publish measures
Enforces the minimum information set for the measure metadata required by HL7 and other organizations that share and publish measures
Subclass of hl7.model.Measure (The Measure resource provides the definition of a quality measure.)
- Value Params
- `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
Inherits all params from parent. Requires the following fields which were optional in the parent: url, name, version, publisher, description, experimental.
- Companion
- object
Enforces the minimum information set for the plan definition metadata required by HL7 and other organizations that share and publish plan definitions
Enforces the minimum information set for the plan definition metadata required by HL7 and other organizations that share and publish plan definitions
Subclass of hl7.model.PlanDefinition (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.)
- Value Params
- `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
Inherits all params from parent. Requires the following fields which were optional in the parent: url, name, version, publisher, description, experimental.
- Companion
- object
- Companion
- class
- Companion
- class
- Companion
- class
- Companion
- class
- Companion
- class
- Companion
- class
- Companion
- class
Base StructureDefinition for SubstanceAmount Type: Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.
Base StructureDefinition for SubstanceAmount Type: Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.
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 Params
- amount
- Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.
- amountText
- A textual comment on a numeric value.
- amountType
- Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements.
- 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.
- 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).
- referenceRange
- Reference range of possible or expected values.
- Constructor
Introduces the fields amount, amountType, amountText, referenceRange.
- Companion
- object
Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.
Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.
Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)
- Value Params
- areaOfHybridisation
- The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore “” shall be used as separator as follows: “Subunitnumber Residue”.
- 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).
- numberOfSubunits
- The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit.
- oligoNucleotideType
- (TBC).
- sequenceType
- The type of the sequence shall be specified based on a controlled vocabulary.
- subunit
- Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times.
- 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 sequenceType, numberOfSubunits, areaOfHybridisation, oligoNucleotideType, subunit.
- Companion
- object
A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators.
A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators.
Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)
- Value Params
- 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.
- disulfideLinkage
- The disulphide bond between two cysteine residues either on the same subunit or on two different subunits shall be described. The position of the disulfide bonds in the SubstanceProtein shall be listed in increasing order of subunit number and position within subunit followed by the abbreviation of the amino acids involved. The disulfide linkage positions shall actually contain the amino acid Cysteine at the respective positions.
- 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).
- numberOfSubunits
- Number of linear sequences of amino acids linked through peptide bonds. The number of subunits constituting the SubstanceProtein shall be described. It is possible that the number of subunits can be variable.
- sequenceType
- The SubstanceProtein descriptive elements will only be used when a complete or partial amino acid sequence is available or derivable from a nucleic acid sequence.
- subunit
- This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times.
- 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 sequenceType, numberOfSubunits, disulfideLinkage, subunit.
- Companion
- object
Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.
Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex.
Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)
- Value Params
- 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.
- countryOfOrigin
- The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For “Plasma-derived substances” the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate.
- developmentStage
- Stage of life for animals, plants, insects and microorganisms. This information shall be provided only when the substance is significantly different in these stages (e.g. foetal bovine serum).
- 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.
- fractionDescription
- Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels.
- geographicalLocation
- The place/region where the plant is harvested or the places/regions where the animal source material has its habitat.
- 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).
- organism
- This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf.
- organismId
- The unique identifier associated with the source material parent organism shall be specified.
- organismName
- The organism accepted Scientific name shall be provided based on the organism taxonomy.
- parentSubstanceId
- The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant).
- parentSubstanceName
- The parent substance of the Herbal Drug, or Herbal preparation.
- partDescription
- To do.
- sourceMaterialClass
- General high level classification of the source material specific to the origin of the material.
- sourceMaterialState
- The state of the source material when extracted.
- sourceMaterialType
- The type of the source material shall be specified based on a controlled vocabulary. For vaccines, this subclause refers to the class of infectious agent.
- 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 organismId, organismName, countryOfOrigin, developmentStage, parentSubstanceId, sourceMaterialType, sourceMaterialClass, sourceMaterialState, parentSubstanceName, geographicalLocation, partDescription, fractionDescription, organism.
- Companion
- object
Explanation of what this profile contains/is for.
Explanation of what this profile contains/is for.
Subclass of hl7.model.Evidence (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.)
- Value Params
- 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.
- Constructor
Inherits all params from parent. Requires the following fields which were optional in the parent: outcome, exposureVariant.
- Companion
- object
FHIR Vital Signs Profile
FHIR Vital Signs Profile
Subclass of hl7.model.Observation (Measurements and simple assertions made about a patient, device or other subject.)
- Value Params
- 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
- Coded Responses from C-CDA Vital Sign Results.
- component
- Used when reporting systolic and diastolic blood pressure.
- 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
- Often just a dateTime for Vital Signs.
- 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
- Used when reporting vital signs panel components.
- 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.
- 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
- 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 thecode
itself specifies the actual focus of the observation.
- 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
- 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
- Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
- Constructor
Inherits all params from parent. Refines the types of: effective. Requires the following fields which were optional in the parent: subject, category, effective.
- Companion
- object