PhdImplementationGuide 0.3.0 - STU 1 (2nd ballot)
This page is part of the Personal Health Device FHIR IG (v0.3.0: STU 1 Ballot 3) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/uv/phd/StructureDefinition/PhdCodedEnumerationObservation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PhdBaseObservation
Summary
Mandatory: 3 elements (7 nested mandatory elements)
Fixed Value: 3 elements
Slices
This structure defines the following Slices:
This structure is derived from PhdBaseObservation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | Reports measurements that are enumeration MDC codes | ||
 meta | 1..1 | Meta | ||
  profile | canonical(StructureDefinition) | Slice: Unordered, Open by value:value | ||
 profile | 1..1 | canonical(StructureDefinition) | Fixed Value: http://hl7.org/fhir/uv/phd/StructureDefinition/PhdCodedEnumerationObservation | |
 valueCodeableConcept | 0..1 | CodeableConcept | ||
| coding | Coding | Slice: Unordered, Open by value:system | ||
| coding | 1..1 | Coding | Required MDC code entry | |
  system | 1..1 | uri | Fixed Value: urn:iso:std:iso:11073:10101 | |
| dataAbsentReason | 0..1 | CodeableConcept | Populated when the Measurement-Status or an Enum-Observed-Value status indicates invalid, not unavailable, or msmt ongoing | |
| coding | Coding | Slice: Unordered, Open by value:system | ||
| coding | 1..1 | Coding | ||
 system | 1..1 | uri | Fixed Value: http://terminology.hl7.org/CodeSystem/data-absent-reason | |
| code | 1..1 | code | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | Reports measurements that are enumeration MDC codes | |
 id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
 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 | Σ | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value | |
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/uv/phd/StructureDefinition/PhdCodedEnumerationObservation |
| security | Σ | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:system, value:code Binding: All Security Labels (extensible) | |
| security | Σ | 0..1 | Coding | Security value set to HTEST when measurement status indicates demo or test data Binding: All Security Labels (extensible) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HTEST |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) |
| 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 | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
 contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..1 | Extension | Extension for the PHG | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "http://hl7.org/fhir/StructureDefinition/observation-gatewayDevice" | ||
 valueReference | 1..1 | Reference() | Reference to the Personal Health Gateway (PHG) Device | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | Identifier | Business Identifier for observation Slice: Unordered, Open by exists:value, exists:system, exists:type | |
| identifier | Σ | 0..1 | Identifier | Unique identifier of this measurement for a given patient and device |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| value | Σ | 1..1 | string | The value that is unique Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| 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 | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
| category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred) | |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | The 11073-10101 MDC code for the measurement |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:11073:10101 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..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 |
| coding | Σ | 0..1 | Coding | The LOINC code for the measurement |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..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 | It is recommended to display at least the reference identifier for the MDC code |
| subject | Σ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| 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 |
 effective[x] | Σ | 1..1 | dateTime, Period | 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 |
| valueCodeableConcept | ΣI | 0..1 | CodeableConcept | Actual result |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | Required MDC code entry |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:11073:10101 |
| 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 |
| dataAbsentReason | I | 0..1 | CodeableConcept | Populated when the Measurement-Status or an Enum-Observed-Value status indicates invalid, not unavailable, or msmt ongoing Binding: DataAbsentReason (extensible) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/data-absent-reason |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..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 |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | Measurement status interpretation when questionable, calibration-ongoing, validated, early-indication, threshold exceeded, alarm inhibited |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/pocd/CodeSystem/measurement-status |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..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 |
| note | 0..* | Annotation | Comments about the observation | |
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example) | |
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example) | |
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
| device | 1..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 1..1 | string | Reference to the device responsible for the measurement |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
| 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) | |
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example) | |
| 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) | Reference to the Coincident Time Stamp Observation and/or Source-Handle-Reference Observation |
| component | ΣI | BackboneElement | Component results Slice: Unordered, Open by value:code | |
 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 | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example) |
| value[x] | Σ | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result |
| dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible) |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
 referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
| component | ΣI | 0..* | BackboneElement | Supplemental Type: A further description of the measurement type. |
| 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 | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: CodeableConcept 11073 Attributes (required) |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | The 11073-10101 MDC code for the measurement |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:11073:10101 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 68193 |
| 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 |
| valueCodeableConcept | Σ | 1..1 | CodeableConcept | Actual component result |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | Required MDC code entry. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:11073:10101 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..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 |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
| referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
| component | ΣI | 0..1 | BackboneElement | Relative time stamp of the measurement reported by the PHD. |
| 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 | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Quantity 11073 Attributes (required) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | The 11073-10101 MDC code for the measurement |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:11073:10101 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 67985 |
| 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 |
| valueQuantity | Σ | 1..1 | Quantity | Actual component result |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required) |
| unit | Σ | 0..1 | string | Unit representation |
| system | ΣI | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | Σ | 1..1 | code | Coded form of the unit Fixed Value: us |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
| referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
| component | ΣI | 0..1 | BackboneElement | Hi-Resolution Relative time stamp of the measurement reported by the PHD. |
| 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 | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Quantity 11073 Attributes (required) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | The 11073-10101 MDC code for the measurement |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:11073:10101 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 68073 |
| 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 |
| valueQuantity | Σ | 1..1 | Quantity | Actual component result |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value | Σ | 1..1 | decimal | Numerical value |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required) |
| unit | Σ | 0..1 | string | Unit representation |
| system | ΣI | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | Σ | 1..1 | code | Coded form of the unit Fixed Value: us |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
| referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
| Documentation for this format | ||||
This structure is derived from PhdBaseObservation
Summary
Mandatory: 3 elements (7 nested mandatory elements)
Fixed Value: 3 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from PhdBaseObservation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | Reports measurements that are enumeration MDC codes | ||
| meta | 1..1 | Meta | ||
| profile | canonical(StructureDefinition) | Slice: Unordered, Open by value:value | ||
| profile | 1..1 | canonical(StructureDefinition) | Fixed Value: http://hl7.org/fhir/uv/phd/StructureDefinition/PhdCodedEnumerationObservation | |
| valueCodeableConcept | 0..1 | CodeableConcept | ||
| coding | Coding | Slice: Unordered, Open by value:system | ||
| coding | 1..1 | Coding | Required MDC code entry | |
| system | 1..1 | uri | Fixed Value: urn:iso:std:iso:11073:10101 | |
| dataAbsentReason | 0..1 | CodeableConcept | Populated when the Measurement-Status or an Enum-Observed-Value status indicates invalid, not unavailable, or msmt ongoing | |
| coding | Coding | Slice: Unordered, Open by value:system | ||
| coding | 1..1 | Coding | ||
| system | 1..1 | uri | Fixed Value: http://terminology.hl7.org/CodeSystem/data-absent-reason | |
| code | 1..1 | code | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | Reports measurements that are enumeration MDC codes | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
| 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 | Σ | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value | |
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/uv/phd/StructureDefinition/PhdCodedEnumerationObservation |
| security | Σ | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:system, value:code Binding: All Security Labels (extensible) | |
| security | Σ | 0..1 | Coding | Security value set to HTEST when measurement status indicates demo or test data Binding: All Security Labels (extensible) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActReason |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HTEST |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) |
| 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 | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..1 | Extension | Extension for the PHG | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | "http://hl7.org/fhir/StructureDefinition/observation-gatewayDevice" | ||
| valueReference | 1..1 | Reference() | Reference to the Personal Health Gateway (PHG) Device | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | Identifier | Business Identifier for observation Slice: Unordered, Open by exists:value, exists:system, exists:type | |
| identifier | Σ | 0..1 | Identifier | Unique identifier of this measurement for a given patient and device |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| value | Σ | 1..1 | string | The value that is unique Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| 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 | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
| category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred) | |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | The 11073-10101 MDC code for the measurement |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:11073:10101 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..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 |
| coding | Σ | 0..1 | Coding | The LOINC code for the measurement |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..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 | It is recommended to display at least the reference identifier for the MDC code |
| subject | Σ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| 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 |
| effective[x] | Σ | 1..1 | dateTime, Period | 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 |
| valueCodeableConcept | ΣI | 0..1 | CodeableConcept | Actual result |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | Required MDC code entry |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:11073:10101 |
| 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 |
| dataAbsentReason | I | 0..1 | CodeableConcept | Populated when the Measurement-Status or an Enum-Observed-Value status indicates invalid, not unavailable, or msmt ongoing Binding: DataAbsentReason (extensible) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/data-absent-reason |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..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 |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | Measurement status interpretation when questionable, calibration-ongoing, validated, early-indication, threshold exceeded, alarm inhibited |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/pocd/CodeSystem/measurement-status |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..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 |
| note | 0..* | Annotation | Comments about the observation | |
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example) | |
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example) | |
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
| device | 1..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 1..1 | string | Reference to the device responsible for the measurement |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 0..1 | string | Text alternative for the resource |
| referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
| 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) | |
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example) | |
| 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) | Reference to the Coincident Time Stamp Observation and/or Source-Handle-Reference Observation |
| component | ΣI | BackboneElement | Component results Slice: Unordered, Open by value:code | |
| 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 | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example) |
| value[x] | Σ | 0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Actual component result |
| dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible) |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
| referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
| component | ΣI | 0..* | BackboneElement | Supplemental Type: A further description of the measurement type. |
| 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 | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: CodeableConcept 11073 Attributes (required) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | The 11073-10101 MDC code for the measurement |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:11073:10101 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 68193 |
| 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 |
| valueCodeableConcept | Σ | 1..1 | CodeableConcept | Actual component result |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | Required MDC code entry. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:11073:10101 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..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 |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
| referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
| component | ΣI | 0..1 | BackboneElement | Relative time stamp of the measurement reported by the PHD. |
| 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 | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Quantity 11073 Attributes (required) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | The 11073-10101 MDC code for the measurement |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:11073:10101 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 67985 |
| 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 |
| valueQuantity | Σ | 1..1 | Quantity | Actual component result |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value | Σ | 1..1 | decimal | Numerical value (with implicit precision) |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required) |
| unit | Σ | 0..1 | string | Unit representation |
| system | ΣI | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | Σ | 1..1 | code | Coded form of the unit Fixed Value: us |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
| referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
| component | ΣI | 0..1 | BackboneElement | Hi-Resolution Relative time stamp of the measurement reported by the PHD. |
| 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 | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Quantity 11073 Attributes (required) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding | Σ | 1..1 | Coding | The 11073-10101 MDC code for the measurement |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: urn:iso:std:iso:11073:10101 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 68073 |
| 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 |
| valueQuantity | Σ | 1..1 | Quantity | Actual component result |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| value | Σ | 1..1 | decimal | Numerical value |
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required) |
| unit | Σ | 0..1 | string | Unit representation |
| system | ΣI | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | Σ | 1..1 | code | Coded form of the unit Fixed Value: us |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible) | |
| referenceRange | 0..* | Unknown reference to #Observation.referenceRange Provides guide for interpretation of component result | ||
| Documentation for this format | ||||
Other representations of profile: Schematron
| Id | Path | Details | Requirements |
| dom-2 | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-4 | Observation | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | Observation | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-6 | Observation | A resource should have narrative for robust management : text.div.exists() | |
| dom-5 | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| obs-7 | Observation | If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty() | |
| obs-6 | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
| ele-1 | Observation.referenceRange | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| obs-3 | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
| ele-1 | Observation.component | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Observation.component | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Observation.component | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Observation.component | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
© HL7.org 2017+ (Devices WG). hl7.fhir.uv.phd#0.3.0 based on FHIR v4.0.0 generated 27/03/2019.
Links: Table of Contents |
QA Report | Search |
Version History |
|
Propose a change