Medtech ALEX® Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-observation | Version: 0.0.1 | |||
Active as of 2025-01-20 | Computable Name: AlexObservation |
The observation exposed by ALEX.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Observation | Measurements and simple assertions dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present observation-code-text-length: Code.text cannot be more than 30 characters observation-note-text-length: Note - text size validation |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. ele-1: All FHIR elements must have a @value or children Required Pattern: final |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Screening Term Value Set for observation result (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Reference to Patient resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Patient ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | instant | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | instant | Clinically relevant time/time-period for observation ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Reference to Practitioner resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Practitioner ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Actual result ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Quantity | Actual result ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit Binding: Unit Value Set for Observation Component (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | High, low, normal, etc. Binding: Interpretation Value Set for Observation (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Annotation | Comments about the observation ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Component results ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Prompt Value Set for Measurement (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Actual component result Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Actual component result ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Quantity | Actual component result ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit Binding: Unit Value Set for Observation Component (extensible) ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet / Code | URI |
Observation.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.code | extensible | ScreeningTerm (a valid code from Screening Term CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/screening-term from this IG | |
Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.value[x]:valueQuantity.code | extensible | ValueQuantityUnit (a valid code from Observation Component Unit CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/value-quantity-unit from this IG | |
Observation.interpretation | extensible | ObservationInterpretation (a valid code from Observation Interpretation CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/observation-interpretation from this IG | |
Observation.component.code | extensible | MeasurementPrompt (a valid code from Measurement Prompt CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/measurement-prompt from this IG | |
Observation.component.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.component.value[x]:valueQuantity.code | extensible | ValueQuantityUnit (a valid code from Observation Component Unit CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/value-quantity-unit from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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-4 | error | 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | 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.intersect(%resource.code.coding).exists()).empty() | |
observation-code-text-length | error | Observation | Code.text cannot be more than 30 characters : code.text.empty() or code.text.length() <= 30 | |
observation-note-text-length | error | Observation | Note - text size validation : note.text.empty() or note.text.length() <= 4096 |
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Observation | Measurements and simple assertions observation-code-text-length: Code.text cannot be more than 30 characters observation-note-text-length: Note - text size validation |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: Definition of Confidentiality Value Set (required) | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | code | registered | preliminary | final | amended + Required Pattern: final | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Screening Term Value Set for observation result (extensible) |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reference to Patient resource |
![]() ![]() ![]() ![]() |
0..1 | string | External Name of Patient | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | instant | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
S | 1..1 | instant | Clinically relevant time/time-period for observation |
![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reference to Practitioner resource |
![]() ![]() ![]() ![]() |
0..1 | string | External Name of Practitioner | |
![]() ![]() ![]() |
0..1 | Actual result Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Actual result |
![]() ![]() ![]() ![]() |
0..1 | Quantity | Actual result | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Coded form of the unit Binding: Unit Value Set for Observation Component (extensible) | |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | High, low, normal, etc. Binding: Interpretation Value Set for Observation (extensible) |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
S | 0..* | Annotation | Comments about the observation |
![]() ![]() ![]() ![]() |
S | 1..1 | markdown | The annotation - text content (as markdown) |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Component results |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Prompt Value Set for Measurement (extensible) |
![]() ![]() ![]() ![]() |
0..1 | Actual component result Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Actual component result |
![]() ![]() ![]() ![]() ![]() |
0..1 | Quantity | Actual component result | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Coded form of the unit Binding: Unit Value Set for Observation Component (extensible) | |
![]() |
Path | Conformance | ValueSet | URI |
Observation.meta.security | required | ConfidentialityVShttps://alexapi.medtechglobal.com.au/fhir/ValueSet/confidentiality from this IG | |
Observation.code | extensible | ScreeningTerm (a valid code from Screening Term CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/screening-term from this IG | |
Observation.value[x]:valueQuantity.code | extensible | ValueQuantityUnit (a valid code from Observation Component Unit CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/value-quantity-unit from this IG | |
Observation.interpretation | extensible | ObservationInterpretation (a valid code from Observation Interpretation CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/observation-interpretation from this IG | |
Observation.component.code | extensible | MeasurementPrompt (a valid code from Measurement Prompt CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/measurement-prompt from this IG | |
Observation.component.value[x]:valueQuantity.code | extensible | ValueQuantityUnit (a valid code from Observation Component Unit CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/value-quantity-unit from this IG |
Id | Grade | Path(s) | Details | Requirements |
observation-code-text-length | error | Observation | Code.text cannot be more than 30 characters : code.text.empty() or code.text.length() <= 30 | |
observation-note-text-length | error | Observation | Note - text size validation : note.text.empty() or note.text.length() <= 4096 |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present observation-code-text-length: Code.text cannot be more than 30 characters observation-note-text-length: Note - text size validation |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from |
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: Definition of Confidentiality Value Set (required) |
![]() ![]() ![]() ![]() |
Σ | 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". |
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
![]() ![]() ![]() |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
![]() ![]() ![]() |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Required Pattern: final |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Screening Term Value Set for observation result (extensible) |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Reference to Patient resource |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Patient |
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
![]() ![]() ![]() |
Σ | 1..1 | instant | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | instant | Clinically relevant time/time-period for observation |
![]() ![]() ![]() |
Σ | 0..1 | instant | Date/Time this version was made available |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Reference to Practitioner resource |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Practitioner |
![]() ![]() ![]() |
ΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Actual result |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Quantity | Actual result |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit Binding: Unit Value Set for Observation Component (extensible) |
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | High, low, normal, etc. Binding: Interpretation Value Set for Observation (extensible) |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
S | 0..* | Annotation | Comments about the observation |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation | |
![]() ![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the annotation was made |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
![]() ![]() ![]() |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |
![]() ![]() ![]() |
0..1 | Reference(Specimen) | Specimen used for this observation | |
![]() ![]() ![]() |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
![]() ![]() ![]() |
C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
![]() ![]() ![]() ![]() |
0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() ![]() |
0..1 | string | Text based reference range in an observation | |
![]() ![]() ![]() |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group |
![]() ![]() ![]() |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from |
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Component results |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Prompt Value Set for Measurement (extensible) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Actual component result Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Actual component result |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Quantity | Actual component result |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit Binding: Unit Value Set for Observation Component (extensible) |
![]() ![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
![]() ![]() ![]() ![]() |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Observation.meta.security | required | ConfidentialityVShttps://alexapi.medtechglobal.com.au/fhir/ValueSet/confidentiality from this IG | |
Observation.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
Observation.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.code | extensible | ScreeningTerm (a valid code from Screening Term CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/screening-term from this IG | |
Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Observation.performer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.value[x]:valueQuantity.code | extensible | ValueQuantityUnit (a valid code from Observation Component Unit CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/value-quantity-unit from this IG | |
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Observation.interpretation | extensible | ObservationInterpretation (a valid code from Observation Interpretation CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/observation-interpretation from this IG | |
Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard | |
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | |
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | |
Observation.component.code | extensible | MeasurementPrompt (a valid code from Measurement Prompt CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/measurement-prompt from this IG | |
Observation.component.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.component.value[x]:valueQuantity.code | extensible | ValueQuantityUnit (a valid code from Observation Component Unit CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/value-quantity-unit from this IG | |
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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-4 | error | 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | 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.intersect(%resource.code.coding).exists()).empty() | |
observation-code-text-length | error | Observation | Code.text cannot be more than 30 characters : code.text.empty() or code.text.length() <= 30 | |
observation-note-text-length | error | Observation | Note - text size validation : note.text.empty() or note.text.length() <= 4096 |
This structure is derived from Observation
Summary
Mandatory: 11 elements(2 nested mandatory elements)
Must-Support: 19 elements
Prohibited: 7 elements
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Observation | Measurements and simple assertions dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present observation-code-text-length: Code.text cannot be more than 30 characters observation-note-text-length: Note - text size validation |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. ele-1: All FHIR elements must have a @value or children Required Pattern: final |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Screening Term Value Set for observation result (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Reference to Patient resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Patient ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | instant | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | instant | Clinically relevant time/time-period for observation ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Reference to Practitioner resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Practitioner ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
ΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Actual result ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Quantity | Actual result ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit Binding: Unit Value Set for Observation Component (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | High, low, normal, etc. Binding: Interpretation Value Set for Observation (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Annotation | Comments about the observation ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Component results ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Prompt Value Set for Measurement (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Actual component result Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Actual component result ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Quantity | Actual component result ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit Binding: Unit Value Set for Observation Component (extensible) ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet / Code | URI |
Observation.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.code | extensible | ScreeningTerm (a valid code from Screening Term CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/screening-term from this IG | |
Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.value[x]:valueQuantity.code | extensible | ValueQuantityUnit (a valid code from Observation Component Unit CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/value-quantity-unit from this IG | |
Observation.interpretation | extensible | ObservationInterpretation (a valid code from Observation Interpretation CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/observation-interpretation from this IG | |
Observation.component.code | extensible | MeasurementPrompt (a valid code from Measurement Prompt CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/measurement-prompt from this IG | |
Observation.component.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.component.value[x]:valueQuantity.code | extensible | ValueQuantityUnit (a valid code from Observation Component Unit CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/value-quantity-unit from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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-4 | error | 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | 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.intersect(%resource.code.coding).exists()).empty() | |
observation-code-text-length | error | Observation | Code.text cannot be more than 30 characters : code.text.empty() or code.text.length() <= 30 | |
observation-note-text-length | error | Observation | Note - text size validation : note.text.empty() or note.text.length() <= 4096 |
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Observation | Measurements and simple assertions observation-code-text-length: Code.text cannot be more than 30 characters observation-note-text-length: Note - text size validation |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: Definition of Confidentiality Value Set (required) | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | code | registered | preliminary | final | amended + Required Pattern: final | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Screening Term Value Set for observation result (extensible) |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reference to Patient resource |
![]() ![]() ![]() ![]() |
0..1 | string | External Name of Patient | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | instant | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
S | 1..1 | instant | Clinically relevant time/time-period for observation |
![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reference to Practitioner resource |
![]() ![]() ![]() ![]() |
0..1 | string | External Name of Practitioner | |
![]() ![]() ![]() |
0..1 | Actual result Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Actual result |
![]() ![]() ![]() ![]() |
0..1 | Quantity | Actual result | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Coded form of the unit Binding: Unit Value Set for Observation Component (extensible) | |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | High, low, normal, etc. Binding: Interpretation Value Set for Observation (extensible) |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
S | 0..* | Annotation | Comments about the observation |
![]() ![]() ![]() ![]() |
S | 1..1 | markdown | The annotation - text content (as markdown) |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Component results |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Prompt Value Set for Measurement (extensible) |
![]() ![]() ![]() ![]() |
0..1 | Actual component result Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Actual component result |
![]() ![]() ![]() ![]() ![]() |
0..1 | Quantity | Actual component result | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Coded form of the unit Binding: Unit Value Set for Observation Component (extensible) | |
![]() |
Path | Conformance | ValueSet | URI |
Observation.meta.security | required | ConfidentialityVShttps://alexapi.medtechglobal.com.au/fhir/ValueSet/confidentiality from this IG | |
Observation.code | extensible | ScreeningTerm (a valid code from Screening Term CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/screening-term from this IG | |
Observation.value[x]:valueQuantity.code | extensible | ValueQuantityUnit (a valid code from Observation Component Unit CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/value-quantity-unit from this IG | |
Observation.interpretation | extensible | ObservationInterpretation (a valid code from Observation Interpretation CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/observation-interpretation from this IG | |
Observation.component.code | extensible | MeasurementPrompt (a valid code from Measurement Prompt CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/measurement-prompt from this IG | |
Observation.component.value[x]:valueQuantity.code | extensible | ValueQuantityUnit (a valid code from Observation Component Unit CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/value-quantity-unit from this IG |
Id | Grade | Path(s) | Details | Requirements |
observation-code-text-length | error | Observation | Code.text cannot be more than 30 characters : code.text.empty() or code.text.length() <= 30 | |
observation-note-text-length | error | Observation | Note - text size validation : note.text.empty() or note.text.length() <= 4096 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present observation-code-text-length: Code.text cannot be more than 30 characters observation-note-text-length: Note - text size validation |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from |
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: Definition of Confidentiality Value Set (required) |
![]() ![]() ![]() ![]() |
Σ | 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". |
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
![]() ![]() ![]() |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
![]() ![]() ![]() |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Required Pattern: final |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Screening Term Value Set for observation result (extensible) |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Reference to Patient resource |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Patient |
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
![]() ![]() ![]() |
Σ | 1..1 | instant | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | instant | Clinically relevant time/time-period for observation |
![]() ![]() ![]() |
Σ | 0..1 | instant | Date/Time this version was made available |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | Reference to Practitioner resource |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | External Name of Practitioner |
![]() ![]() ![]() |
ΣC | 0..1 | Actual result Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Actual result |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Quantity | Actual result |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit Binding: Unit Value Set for Observation Component (extensible) |
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | High, low, normal, etc. Binding: Interpretation Value Set for Observation (extensible) |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
S | 0..* | Annotation | Comments about the observation |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Individual responsible for the annotation | |
![]() ![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | When the annotation was made |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
![]() ![]() ![]() |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |
![]() ![]() ![]() |
0..1 | Reference(Specimen) | Specimen used for this observation | |
![]() ![]() ![]() |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
![]() ![]() ![]() |
C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Low Range, if relevant |
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | High Range, if relevant |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
![]() ![]() ![]() ![]() |
0..1 | Range | Applicable age range, if relevant | |
![]() ![]() ![]() ![]() |
0..1 | string | Text based reference range in an observation | |
![]() ![]() ![]() |
Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group |
![]() ![]() ![]() |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from |
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Component results |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Prompt Value Set for Measurement (extensible) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Actual component result Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Actual component result |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Quantity | Actual component result |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Unit representation |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | System that defines coded unit form |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Coded form of the unit Binding: Unit Value Set for Observation Component (extensible) |
![]() ![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
![]() ![]() ![]() ![]() |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
![]() |
Path | Conformance | ValueSet / Code | URI |
Observation.meta.security | required | ConfidentialityVShttps://alexapi.medtechglobal.com.au/fhir/ValueSet/confidentiality from this IG | |
Observation.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
Observation.status | required | Pattern: finalhttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.code | extensible | ScreeningTerm (a valid code from Screening Term CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/screening-term from this IG | |
Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Observation.performer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | |
Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.value[x]:valueQuantity.code | extensible | ValueQuantityUnit (a valid code from Observation Component Unit CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/value-quantity-unit from this IG | |
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Observation.interpretation | extensible | ObservationInterpretation (a valid code from Observation Interpretation CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/observation-interpretation from this IG | |
Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard | |
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | |
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | |
Observation.component.code | extensible | MeasurementPrompt (a valid code from Measurement Prompt CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/measurement-prompt from this IG | |
Observation.component.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.component.value[x]:valueQuantity.code | extensible | ValueQuantityUnit (a valid code from Observation Component Unit CodeSystem)https://alexapi.medtechglobal.com.au/fhir/ValueSet/value-quantity-unit from this IG | |
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | |
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Observation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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-4 | error | 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-5 | error | Observation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Observation | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-3 | error | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() | |
obs-6 | error | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty() | |
obs-7 | error | 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.intersect(%resource.code.coding).exists()).empty() | |
observation-code-text-length | error | Observation | Code.text cannot be more than 30 characters : code.text.empty() or code.text.length() <= 30 | |
observation-note-text-length | error | Observation | Note - text size validation : note.text.empty() or note.text.length() <= 4096 |
This structure is derived from Observation
Summary
Mandatory: 11 elements(2 nested mandatory elements)
Must-Support: 19 elements
Prohibited: 7 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron