This page is part of the Point-of-care Device FHIR IG (v0.3.0: STU 1 Ballot 3) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/uv/pocd/StructureDefinition/SampleArrayObservation |
Version: | 0.3.0 |
Name: | SampleArrayObservation |
Title: | Sample Array Observation profile |
Status: | Draft as of 2021-07-24 |
Definition: | StructureDefinition for Observation resources that represent real-time waveforms or wave snippets. |
Publisher: | HL7 International - Devices Work Group |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/pocd/StructureDefinition/SampleArrayObservation
This profile sets minimum expectations for the Observation resource that represents real-time waveform or wave snippet.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Summary
The profile defines the following rules:
Observation.code
shall have a coding from the ISO/IEEE 11073 MDC Metric nomenclature if there is an appropriate code available.Observation.valueSampledData
or Observation.component.valueSampledData
shall be present. Values shall have a UCUM unit code.Observation.interpretation
or Observation.component.interpretation
coding includes measurement status.Observation.device
shall be present and refer to the Sample Array DeviceMetric resource which this observation belongs to.Mandatory: 2 elements
Must-Support: 15 elements
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions | |
meta | 0..1 | Meta | Metadata about the resource | |
security | S | 0..* | Coding | Security Labels applied to this resource |
status | S | 1..1 | code | registered | preliminary | final | amended + |
category | S | 0..* | CodeableConcept | Classification of type of observation |
code | S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: MDC Metric nomenclature (extensible) |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
version | 0..1 | string | Version of the system - if relevant | |
code | 0..1 | code | Symbol in syntax defined by the system | |
subject | S | 1..1 | Reference(Patient | MDS Device profile) | Who and/or what the observation is about |
effective[x] | S | 0..1 | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation |
effectivePeriod | 0..1 | Period | Clinically relevant time/time-period for observation | |
start | 0..1 | dateTime | Starting time with inclusive boundary | |
end | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
effectiveInstant | 0..1 | instant | Clinically relevant time/time-period for observation | |
Slices for value[x] | S | 0..1 | SampledData | Actual result Slice: Unordered, Closed by type:$this |
valueSampledData:valueSampledData | 0..1 | SampledData | Actual result | |
origin | 1..1 | SimpleQuantity | Zero value and units | |
system | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
code | 0..1 | code | Coded form of the unit | |
data | 0..1 | string | Decimal values with spaces, or "E" | "U" | "L" | |
interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: Observation interpretation codes (extensible) |
bodySite | S | 0..1 | CodeableConcept | Observed body part |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
version | 0..1 | string | Version of the system - if relevant | |
code | 0..1 | code | Symbol in syntax defined by the system | |
device | S | 1..1 | Reference(Sample Array DeviceMetric profile) | (Measurement) Device |
referenceRange | S | 0..* | BackboneElement | Provides guide for interpretation |
low | 0..1 | SimpleQuantity | Low Range, if relevant | |
high | 0..1 | SimpleQuantity | High Range, if relevant | |
component | 0..* | BackboneElement | Component results | |
code | S | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: MDC Metric nomenclature (extensible) |
coding | 0..* | Coding | Code defined by a terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
Slices for value[x] | S | 0..1 | SampledData | Actual component result Slice: Unordered, Closed by type:$this |
valueSampledData:valueSampledData | 0..1 | SampledData | Actual component result | |
origin | 1..1 | SimpleQuantity | Zero value and units | |
system | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
code | 0..1 | code | Coded form of the unit | |
data | 0..1 | string | Decimal values with spaces, or "E" | "U" | "L" | |
interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: Observation interpretation codes (extensible) |
referenceRange | S | 0..* | BackboneElement | Provides guide for interpretation of component result |
low | 0..1 | SimpleQuantity | Low Range, if relevant | |
high | 0..1 | SimpleQuantity | High Range, if relevant | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | Measurements and simple assertions |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
source | Σ | 0..1 | uri | Identifies where the resource comes from |
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
security | SΣ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business Identifier for observation |
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
category | S | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: MDC Metric nomenclature (extensible) |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
subject | SΣ | 1..1 | Reference(Patient | MDS Device profile) | Who and/or what the observation is about |
focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
Slices for effective[x] | SΣ | 0..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
effective[x]:effectivePeriod | Σ | 0..1 | Period | Clinically relevant time/time-period for observation |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary |
end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
effective[x]:effectiveInstant | Σ | 0..1 | instant | Clinically relevant time/time-period for observation |
issued | Σ | 0..1 | instant | Date/Time this version was made available |
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
Slices for value[x] | SΣI | 0..1 | SampledData | Actual result Slice: Unordered, Closed by type:$this |
value[x]:valueSampledData | ΣI | 0..1 | SampledData | Actual result |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
origin | Σ | 1..1 | SimpleQuantity | Zero value and units |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | Σ | 0..1 | string | Unit representation |
system | ΣI | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | Σ | 0..1 | code | Coded form of the unit |
period | Σ | 1..1 | decimal | Number of milliseconds between samples |
factor | Σ | 0..1 | decimal | Multiply data by this before adding to origin |
lowerLimit | Σ | 0..1 | decimal | Lower limit of detection |
upperLimit | Σ | 0..1 | decimal | Upper limit of detection |
dimensions | Σ | 1..1 | positiveInt | Number of sample points at each time point |
data | 0..1 | string | Decimal values with spaces, or "E" | "U" | "L" | |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: Observation interpretation codes (extensible) |
note | 0..* | Annotation | Comments about the observation | |
bodySite | S | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
device | S | 1..1 | Reference(Sample Array DeviceMetric profile) | (Measurement) Device |
referenceRange | SI | 0..* | BackboneElement | Provides guide for interpretation |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |
appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group |
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from |
component | Σ | 0..* | BackboneElement | Component results |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: MDC Metric nomenclature (extensible) |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
Slices for value[x] | SΣ | 0..1 | SampledData | Actual component result Slice: Unordered, Closed by type:$this |
value[x]:valueSampledData | Σ | 0..1 | SampledData | Actual component result |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
origin | Σ | 1..1 | SimpleQuantity | Zero value and units |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | Σ | 0..1 | string | Unit representation |
system | ΣI | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | Σ | 0..1 | code | Coded form of the unit |
period | Σ | 1..1 | decimal | Number of milliseconds between samples |
factor | Σ | 0..1 | decimal | Multiply data by this before adding to origin |
lowerLimit | Σ | 0..1 | decimal | Lower limit of detection |
upperLimit | Σ | 0..1 | decimal | Upper limit of detection |
dimensions | Σ | 1..1 | positiveInt | Number of sample points at each time point |
data | 0..1 | string | Decimal values with spaces, or "E" | "U" | "L" | |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: Observation interpretation codes (extensible) |
referenceRange | S | 0..* | BackboneElement | Provides guide for interpretation of component result |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |
appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | Measurements and simple assertions |
meta | Σ | 0..1 | Meta | Metadata about the resource |
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: MDC Metric nomenclature (extensible) |
subject | Σ | 1..1 | Reference(Patient | MDS Device profile) | Who and/or what the observation is about |
Slices for effective[x] | Σ | 0..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
Slices for value[x] | ΣI | 0..1 | SampledData | Actual result Slice: Unordered, Closed by type:$this |
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: Observation interpretation codes (extensible) | |
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
device | 1..1 | Reference(Sample Array DeviceMetric profile) | (Measurement) Device | |
referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation |
component | Σ | 0..* | BackboneElement | Component results |
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: MDC Metric nomenclature (extensible) |
Slices for value[x] | Σ | 0..1 | SampledData | Actual component result Slice: Unordered, Closed by type:$this |
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: Observation interpretation codes (extensible) | |
referenceRange | 0..* | BackboneElement | Provides guide for interpretation of component result | |
Documentation for this format |
This structure is derived from Observation
Summary
The profile defines the following rules:
Observation.code
shall have a coding from the ISO/IEEE 11073 MDC Metric nomenclature if there is an appropriate code available.Observation.valueSampledData
or Observation.component.valueSampledData
shall be present. Values shall have a UCUM unit code.Observation.interpretation
or Observation.component.interpretation
coding includes measurement status.Observation.device
shall be present and refer to the Sample Array DeviceMetric resource which this observation belongs to.Mandatory: 2 elements
Must-Support: 15 elements
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions | |
meta | 0..1 | Meta | Metadata about the resource | |
security | S | 0..* | Coding | Security Labels applied to this resource |
status | S | 1..1 | code | registered | preliminary | final | amended + |
category | S | 0..* | CodeableConcept | Classification of type of observation |
code | S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: MDC Metric nomenclature (extensible) |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
version | 0..1 | string | Version of the system - if relevant | |
code | 0..1 | code | Symbol in syntax defined by the system | |
subject | S | 1..1 | Reference(Patient | MDS Device profile) | Who and/or what the observation is about |
effective[x] | S | 0..1 | dateTime, Period, Timing, instant | Clinically relevant time/time-period for observation |
effectivePeriod | 0..1 | Period | Clinically relevant time/time-period for observation | |
start | 0..1 | dateTime | Starting time with inclusive boundary | |
end | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
effectiveInstant | 0..1 | instant | Clinically relevant time/time-period for observation | |
Slices for value[x] | S | 0..1 | SampledData | Actual result Slice: Unordered, Closed by type:$this |
valueSampledData:valueSampledData | 0..1 | SampledData | Actual result | |
origin | 1..1 | SimpleQuantity | Zero value and units | |
system | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
code | 0..1 | code | Coded form of the unit | |
data | 0..1 | string | Decimal values with spaces, or "E" | "U" | "L" | |
interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: Observation interpretation codes (extensible) |
bodySite | S | 0..1 | CodeableConcept | Observed body part |
coding | 0..* | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system | |
version | 0..1 | string | Version of the system - if relevant | |
code | 0..1 | code | Symbol in syntax defined by the system | |
device | S | 1..1 | Reference(Sample Array DeviceMetric profile) | (Measurement) Device |
referenceRange | S | 0..* | BackboneElement | Provides guide for interpretation |
low | 0..1 | SimpleQuantity | Low Range, if relevant | |
high | 0..1 | SimpleQuantity | High Range, if relevant | |
component | 0..* | BackboneElement | Component results | |
code | S | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: MDC Metric nomenclature (extensible) |
coding | 0..* | Coding | Code defined by a terminology system | |
code | 0..1 | code | Symbol in syntax defined by the system | |
Slices for value[x] | S | 0..1 | SampledData | Actual component result Slice: Unordered, Closed by type:$this |
valueSampledData:valueSampledData | 0..1 | SampledData | Actual component result | |
origin | 1..1 | SimpleQuantity | Zero value and units | |
system | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
code | 0..1 | code | Coded form of the unit | |
data | 0..1 | string | Decimal values with spaces, or "E" | "U" | "L" | |
interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: Observation interpretation codes (extensible) |
referenceRange | S | 0..* | BackboneElement | Provides guide for interpretation of component result |
low | 0..1 | SimpleQuantity | Low Range, if relevant | |
high | 0..1 | SimpleQuantity | High Range, if relevant | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | Measurements and simple assertions |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
source | Σ | 0..1 | uri | Identifies where the resource comes from |
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
security | SΣ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business Identifier for observation |
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
category | S | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: MDC Metric nomenclature (extensible) |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
subject | SΣ | 1..1 | Reference(Patient | MDS Device profile) | Who and/or what the observation is about |
focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
Slices for effective[x] | SΣ | 0..1 | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
effectiveDateTime | dateTime | |||
effectivePeriod | Period | |||
effectiveTiming | Timing | |||
effectiveInstant | instant | |||
effective[x]:effectivePeriod | Σ | 0..1 | Period | Clinically relevant time/time-period for observation |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary |
end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
effective[x]:effectiveInstant | Σ | 0..1 | instant | Clinically relevant time/time-period for observation |
issued | Σ | 0..1 | instant | Date/Time this version was made available |
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
Slices for value[x] | SΣI | 0..1 | SampledData | Actual result Slice: Unordered, Closed by type:$this |
value[x]:valueSampledData | ΣI | 0..1 | SampledData | Actual result |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
origin | Σ | 1..1 | SimpleQuantity | Zero value and units |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | Σ | 0..1 | string | Unit representation |
system | ΣI | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | Σ | 0..1 | code | Coded form of the unit |
period | Σ | 1..1 | decimal | Number of milliseconds between samples |
factor | Σ | 0..1 | decimal | Multiply data by this before adding to origin |
lowerLimit | Σ | 0..1 | decimal | Lower limit of detection |
upperLimit | Σ | 0..1 | decimal | Upper limit of detection |
dimensions | Σ | 1..1 | positiveInt | Number of sample points at each time point |
data | 0..1 | string | Decimal values with spaces, or "E" | "U" | "L" | |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: Observation interpretation codes (extensible) |
note | 0..* | Annotation | Comments about the observation | |
bodySite | S | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
device | S | 1..1 | Reference(Sample Array DeviceMetric profile) | (Measurement) Device |
referenceRange | SI | 0..* | BackboneElement | Provides guide for interpretation |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |
appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group |
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from |
component | Σ | 0..* | BackboneElement | Component results |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: MDC Metric nomenclature (extensible) |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
Slices for value[x] | SΣ | 0..1 | SampledData | Actual component result Slice: Unordered, Closed by type:$this |
value[x]:valueSampledData | Σ | 0..1 | SampledData | Actual component result |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
origin | Σ | 1..1 | SimpleQuantity | Zero value and units |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) |
unit | Σ | 0..1 | string | Unit representation |
system | ΣI | 0..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | Σ | 0..1 | code | Coded form of the unit |
period | Σ | 1..1 | decimal | Number of milliseconds between samples |
factor | Σ | 0..1 | decimal | Multiply data by this before adding to origin |
lowerLimit | Σ | 0..1 | decimal | Lower limit of detection |
upperLimit | Σ | 0..1 | decimal | Upper limit of detection |
dimensions | Σ | 1..1 | positiveInt | Number of sample points at each time point |
data | 0..1 | string | Decimal values with spaces, or "E" | "U" | "L" | |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
interpretation | S | 0..* | CodeableConcept | High, low, normal, etc. Binding: Observation interpretation codes (extensible) |
referenceRange | S | 0..* | BackboneElement | Provides guide for interpretation of component result |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |
appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron