com.babylonhealth.lit.usbase.model

`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.

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

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.

specimen

• The specimen that was used when this observation was made.

status

• The status of the result value.

subject

• The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

text

• A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

value

• Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

Inherits all params from parent. Refines the types of: value. Requires the following fields which were optional in the parent: value.

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.

specimen

• The specimen that was used when this observation was made.

status

• The status of the result value.

subject

• The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

text

• A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

value

• Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

Inherits all params from parent. Refines the types of: value.

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.

specimen

• The specimen that was used when this observation was made.

status

• The status of the result value.

subject

• The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

text

• A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

value

• Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

Inherits all params from parent. Refines the types of: value.

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.

specimen

• The specimen that was used when this observation was made.

status

• The status of the result value.

subject

• The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

text

• A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

value

• Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

Inherits all params from parent. Refines the types of: value.

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.

specimen

• The specimen that was used when this observation was made.

status

• The status of the result value.

subject

• The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

text

• A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

value

• Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.

Inherits all params from parent. Refines the types of: value. Requires the following fields which were optional in the parent: component.

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.

Inherits all params from parent. Refines the types of: module. Requires the following fields which were optional in the parent: extension, identifier, requestIdentifier.

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.

Inherits all params from parent. Requires the following fields which were optional in the parent: identifier, instantiatesUri.

`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.

Inherits all params from parent. Requires the following fields which were optional in the parent: extension.

`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.

Inherits all params from parent.

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.

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.

`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.

Inherits all params from parent. Requires the following fields which were optional in the parent: library.

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.

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.

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.

Inherits all params from parent.

`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.

Inherits all params from parent.

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.

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.

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.

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

`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.

Inherits all params from parent.

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.

Inherits all params from parent.

`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.

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.

`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.

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

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.

specimen

• The specimen that was used when this observation was made.

status

• The status of the result value.

subject

• The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.

text

• A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

value

• Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.