AU Base Implementation Guide
6.0.0-draft - Draft

Publication Build: This will be filled in by the publication tooling

## Resource Profile: AU Health Program Participation Summary

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-healthprogramparticipation | Version: 6.0.0-draft
Standards status: Trial-use | Maturity Level: 0 | Computable Name: AUHealthProgramParticipationSummary
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines an observation information structure for a summary of an individual’s participation in a health program, e.g. weight management, disease screening, or substance use therapy. Participation information may include information on an individual’s eligibility for a program, suspension of participation in a program, or status of participation in a program.

### Usage Notes

Usages:

- Examples for this Profile: Observation/healthprogramparticipation-example0 and Observation/healthprogramparticipation-example1

Changes since version 5.0.0:

- New Content

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Observation

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Observation |  | 0..* | Observation | Health program participation summary observation
status |  | 1..1 | code | registered | preliminary | final | amended + Fixed Value: final
Slices for category |  | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this
category:hPCat |  | 1..1 | CodeableConcept | Health program Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program
code |  | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Participation in Health Program (extensible)
subject |  | 1..1 | Reference(Patient) | Who and/or what the observation is about
effective[x] |  | 1..1 | dateTime | Date, and optionally time, this information is asserted as 'true'
Slices for component | C | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code Constraints: inv-hpps-1
component:participationStatus |  | 1..1 | BackboneElement | Current status of an individual's participation in a program
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603781000168102
value[x] |  | 0..1 | CodeableConcept | Actual component result Binding: Health Program Participation Status (required)
component:participationStatusPeriod |  | 0..1 | BackboneElement | Validity period for the program participation status
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603791000168104
value[x] |  | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
component:notParticipantStatusReason |  | 0..* | BackboneElement | Reason for not participating
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603991000168102
value[x] |  | 0..1 | CodeableConcept | Actual component result Binding: Reason For Non Participation In Health Program (preferred)
component:lastAction |  | 0..1 | BackboneElement | Last program participation action
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604001000168105
value[x] |  | 0..1 | CodeableConcept | Actual component result
component:lastActionDate |  | 0..1 | BackboneElement | Last program participation action date
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604011000168108
value[x] |  | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
component:nextAction |  | 0..1 | BackboneElement | Next program participation action
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604021000168101
value[x] |  | 0..1 | CodeableConcept | Actual component result
component:nextActionDate |  | 0..1 | BackboneElement | Next program participation action date
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604031000168103
value[x] |  | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
component:forecastStatus |  | 0..1 | BackboneElement | Forecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604041000168107
value[x] |  | 0..1 | CodeableConcept | Actual component result
component:forecastStatusPeriod |  | 0..1 | BackboneElement | Validity period associated with forecast status
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604051000168109
value[x] |  | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Observation.code | extensible | ParticipationinHealthProgram `https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component:participationStatus.value[x] | required | HealthProgramParticipationStatus `https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component:notParticipantStatusReason.value[x] | preferred | ReasonForNonParticipationInHealthProgram `https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1` From https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-hpps-1 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.exists() |

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Observation | C | 0..* | Observation | Health program participation summary observation Constraints: obs-6, obs-7
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final
Slices for category |  | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:hPCat |  | 1..1 | CodeableConcept | Health program Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program
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
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Participation in Health Program (extensible)
subject | Σ | 1..1 | Reference(Patient) | Who and/or what the observation is about
effective[x] | Σ | 1..1 | dateTime | Date, and optionally time, this information is asserted as 'true'
Slices for component | Σ C | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code Constraints: inv-hpps-1
component:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
component:participationStatus | Σ | 1..1 | BackboneElement | Current status of an individual's participation in a program
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603781000168102
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result Binding: Health Program Participation Status (required)
component:participationStatusPeriod | Σ | 0..1 | BackboneElement | Validity period for the program participation status
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603791000168104
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
component:notParticipantStatusReason | Σ | 0..* | BackboneElement | Reason for not participating
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603991000168102
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result Binding: Reason For Non Participation In Health Program (preferred)
component:lastAction | Σ | 0..1 | BackboneElement | Last program participation action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604001000168105
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result
component:lastActionDate | Σ | 0..1 | BackboneElement | Last program participation action date
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604011000168108
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
component:nextAction | Σ | 0..1 | BackboneElement | Next program participation action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604021000168101
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result
component:nextActionDate | Σ | 0..1 | BackboneElement | Next program participation action date
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604031000168103
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
component:forecastStatus | Σ | 0..1 | BackboneElement | Forecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604041000168107
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result
component:forecastStatusPeriod | Σ | 0..1 | BackboneElement | Validity period associated with forecast status
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604051000168109
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Observation.status | required | Fixed Value: final `http://hl7.org/fhir/ValueSet/observation-status|4.0.1` From the FHIR Standard
Observation.category | preferred | ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:hPCat | preferred | Pattern Value: program `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.code | extensible | ParticipationinHealthProgram `https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component.code | example | LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:participationStatus.code | example | Pattern Value: SNOMED-CT Code 1603781000168102 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:participationStatus.value[x] | required | HealthProgramParticipationStatus `https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component:participationStatusPeriod.code | example | Pattern Value: SNOMED-CT Code 1603791000168104 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:notParticipantStatusReason.code | example | Pattern Value: SNOMED-CT Code 1603991000168102 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:notParticipantStatusReason.value[x] | preferred | ReasonForNonParticipationInHealthProgram `https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component:lastAction.code | example | Pattern Value: SNOMED-CT Code 1604001000168105 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:lastActionDate.code | example | Pattern Value: SNOMED-CT Code 1604011000168108 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:nextAction.code | example | Pattern Value: SNOMED-CT Code 1604021000168101 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:nextActionDate.code | example | Pattern Value: SNOMED-CT Code 1604031000168103 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:forecastStatus.code | example | Pattern Value: SNOMED-CT Code 1604041000168107 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:forecastStatusPeriod.code | example | Pattern Value: SNOMED-CT Code 1604051000168109 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard

#### Constraints

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() |
inv-hpps-1 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.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() |

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Observation | C | 0..* | Observation | Health program participation summary observation Constraints: obs-6, obs-7
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business Identifier for observation
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final
Slices for category |  | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:hPCat |  | 1..1 | CodeableConcept | Health program Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program
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
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Participation in Health Program (extensible)
subject | Σ | 1..1 | Reference(Patient) | Who and/or what the observation is about
focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made
effective[x] | Σ | 1..1 | dateTime | Date, and optionally time, this information is asserted as 'true'
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
value[x] | Σ C | 0..1 |  | Actual result
valueQuantity |  |  | Quantity |
valueCodeableConcept |  |  | CodeableConcept |
valueString |  |  | string |
valueBoolean |  |  | boolean |
valueInteger |  |  | integer |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueSampledData |  |  | SampledData |
valueTime |  |  | time |
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note |  | 0..* | Annotation | Comments about the observation
bodySite |  | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
method |  | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations.
specimen |  | 0..1 | Reference(Specimen) | Specimen used for this observation
device |  | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device
referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
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 | C | 0..1 | SimpleQuantity | Low Range, if relevant
high | C | 0..1 | SimpleQuantity | High Range, if relevant
type |  | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
appliesTo |  | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
age |  | 0..1 | Range | Applicable age range, if relevant
text |  | 0..1 | string | Text based reference range in an observation
hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from
Slices for component | Σ C | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code Constraints: inv-hpps-1
component:All Slices |  |  |  | Content/Rules for all slices
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): Codes identifying names of simple observations.
value[x] | Σ | 0..1 |  | Actual component result
valueQuantity |  |  | Quantity |
valueCodeableConcept |  |  | CodeableConcept |
valueString |  |  | string |
valueBoolean |  |  | boolean |
valueInteger |  |  | integer |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueSampledData |  |  | SampledData |
valueTime |  |  | time |
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:participationStatus | Σ | 1..1 | BackboneElement | Current status of an individual's participation in a program
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603781000168102
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result Binding: Health Program Participation Status (required)
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:participationStatusPeriod | Σ | 0..1 | BackboneElement | Validity period for the program participation status
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603791000168104
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:notParticipantStatusReason | Σ | 0..* | BackboneElement | Reason for not participating
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603991000168102
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result Binding: Reason For Non Participation In Health Program (preferred)
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:lastAction | Σ | 0..1 | BackboneElement | Last program participation action
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604001000168105
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:lastActionDate | Σ | 0..1 | BackboneElement | Last program participation action date
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604011000168108
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:nextAction | Σ | 0..1 | BackboneElement | Next program participation action
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604021000168101
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:nextActionDate | Σ | 0..1 | BackboneElement | Next program participation action date
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604031000168103
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:forecastStatus | Σ | 0..1 | BackboneElement | Forecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604041000168107
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:forecastStatusPeriod | Σ | 0..1 | BackboneElement | Validity period associated with forecast status
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604051000168109
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Observation.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Observation.status | required | Fixed Value: final `http://hl7.org/fhir/ValueSet/observation-status|4.0.1` From the FHIR Standard
Observation.category | preferred | ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:hPCat | preferred | Pattern Value: program `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.code | extensible | ParticipationinHealthProgram `https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1` From https://tx.ontoserver.csiro.au/fhir
Observation.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.bodySite | example | SNOMEDCTBodyStructures `http://hl7.org/fhir/ValueSet/body-site` From the FHIR Standard
Observation.method | example | ObservationMethods `http://hl7.org/fhir/ValueSet/observation-methods` From the FHIR Standard
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes `http://hl7.org/fhir/ValueSet/referencerange-meaning` From the FHIR Standard
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes `http://hl7.org/fhir/ValueSet/referencerange-appliesto` From the FHIR Standard
Observation.component.code | example | LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:participationStatus.code | example | Pattern Value: SNOMED-CT Code 1603781000168102 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:participationStatus.value[x] | required | HealthProgramParticipationStatus `https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component:participationStatus.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:participationStatus.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:participationStatusPeriod.code | example | Pattern Value: SNOMED-CT Code 1603791000168104 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:participationStatusPeriod.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:participationStatusPeriod.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:notParticipantStatusReason.code | example | Pattern Value: SNOMED-CT Code 1603991000168102 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:notParticipantStatusReason.value[x] | preferred | ReasonForNonParticipationInHealthProgram `https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component:notParticipantStatusReason.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:notParticipantStatusReason.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:lastAction.code | example | Pattern Value: SNOMED-CT Code 1604001000168105 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:lastAction.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:lastAction.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:lastActionDate.code | example | Pattern Value: SNOMED-CT Code 1604011000168108 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:lastActionDate.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:lastActionDate.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:nextAction.code | example | Pattern Value: SNOMED-CT Code 1604021000168101 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:nextAction.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:nextAction.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:nextActionDate.code | example | Pattern Value: SNOMED-CT Code 1604031000168103 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:nextActionDate.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:nextActionDate.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:forecastStatus.code | example | Pattern Value: SNOMED-CT Code 1604041000168107 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:forecastStatus.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:forecastStatus.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:forecastStatusPeriod.code | example | Pattern Value: SNOMED-CT Code 1604051000168109 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:forecastStatusPeriod.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:forecastStatusPeriod.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard

#### Constraints

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() |
inv-hpps-1 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.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() |

This structure is derived from Observation

Summary

Mandatory: 6 elements
Fixed: 1 element

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Observation.category
- The element 1 is sliced based on the value of Observation.component

Maturity: 0

Differential View

This structure is derived from Observation

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Observation |  | 0..* | Observation | Health program participation summary observation
status |  | 1..1 | code | registered | preliminary | final | amended + Fixed Value: final
Slices for category |  | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this
category:hPCat |  | 1..1 | CodeableConcept | Health program Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program
code |  | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Participation in Health Program (extensible)
subject |  | 1..1 | Reference(Patient) | Who and/or what the observation is about
effective[x] |  | 1..1 | dateTime | Date, and optionally time, this information is asserted as 'true'
Slices for component | C | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code Constraints: inv-hpps-1
component:participationStatus |  | 1..1 | BackboneElement | Current status of an individual's participation in a program
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603781000168102
value[x] |  | 0..1 | CodeableConcept | Actual component result Binding: Health Program Participation Status (required)
component:participationStatusPeriod |  | 0..1 | BackboneElement | Validity period for the program participation status
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603791000168104
value[x] |  | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
component:notParticipantStatusReason |  | 0..* | BackboneElement | Reason for not participating
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603991000168102
value[x] |  | 0..1 | CodeableConcept | Actual component result Binding: Reason For Non Participation In Health Program (preferred)
component:lastAction |  | 0..1 | BackboneElement | Last program participation action
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604001000168105
value[x] |  | 0..1 | CodeableConcept | Actual component result
component:lastActionDate |  | 0..1 | BackboneElement | Last program participation action date
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604011000168108
value[x] |  | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
component:nextAction |  | 0..1 | BackboneElement | Next program participation action
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604021000168101
value[x] |  | 0..1 | CodeableConcept | Actual component result
component:nextActionDate |  | 0..1 | BackboneElement | Next program participation action date
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604031000168103
value[x] |  | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
component:forecastStatus |  | 0..1 | BackboneElement | Forecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604041000168107
value[x] |  | 0..1 | CodeableConcept | Actual component result
component:forecastStatusPeriod |  | 0..1 | BackboneElement | Validity period associated with forecast status
code |  | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604051000168109
value[x] |  | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Observation.code | extensible | ParticipationinHealthProgram `https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component:participationStatus.value[x] | required | HealthProgramParticipationStatus `https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component:notParticipantStatusReason.value[x] | preferred | ReasonForNonParticipationInHealthProgram `https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1` From https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
inv-hpps-1 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.exists() |

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Observation | C | 0..* | Observation | Health program participation summary observation Constraints: obs-6, obs-7
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final
Slices for category |  | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:hPCat |  | 1..1 | CodeableConcept | Health program Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program
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
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Participation in Health Program (extensible)
subject | Σ | 1..1 | Reference(Patient) | Who and/or what the observation is about
effective[x] | Σ | 1..1 | dateTime | Date, and optionally time, this information is asserted as 'true'
Slices for component | Σ C | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code Constraints: inv-hpps-1
component:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
component:participationStatus | Σ | 1..1 | BackboneElement | Current status of an individual's participation in a program
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603781000168102
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result Binding: Health Program Participation Status (required)
component:participationStatusPeriod | Σ | 0..1 | BackboneElement | Validity period for the program participation status
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603791000168104
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
component:notParticipantStatusReason | Σ | 0..* | BackboneElement | Reason for not participating
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603991000168102
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result Binding: Reason For Non Participation In Health Program (preferred)
component:lastAction | Σ | 0..1 | BackboneElement | Last program participation action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604001000168105
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result
component:lastActionDate | Σ | 0..1 | BackboneElement | Last program participation action date
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604011000168108
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
component:nextAction | Σ | 0..1 | BackboneElement | Next program participation action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604021000168101
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result
component:nextActionDate | Σ | 0..1 | BackboneElement | Next program participation action date
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604031000168103
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
component:forecastStatus | Σ | 0..1 | BackboneElement | Forecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604041000168107
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result
component:forecastStatusPeriod | Σ | 0..1 | BackboneElement | Validity period associated with forecast status
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604051000168109
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Observation.status | required | Fixed Value: final `http://hl7.org/fhir/ValueSet/observation-status|4.0.1` From the FHIR Standard
Observation.category | preferred | ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:hPCat | preferred | Pattern Value: program `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.code | extensible | ParticipationinHealthProgram `https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component.code | example | LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:participationStatus.code | example | Pattern Value: SNOMED-CT Code 1603781000168102 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:participationStatus.value[x] | required | HealthProgramParticipationStatus `https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component:participationStatusPeriod.code | example | Pattern Value: SNOMED-CT Code 1603791000168104 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:notParticipantStatusReason.code | example | Pattern Value: SNOMED-CT Code 1603991000168102 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:notParticipantStatusReason.value[x] | preferred | ReasonForNonParticipationInHealthProgram `https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component:lastAction.code | example | Pattern Value: SNOMED-CT Code 1604001000168105 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:lastActionDate.code | example | Pattern Value: SNOMED-CT Code 1604011000168108 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:nextAction.code | example | Pattern Value: SNOMED-CT Code 1604021000168101 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:nextActionDate.code | example | Pattern Value: SNOMED-CT Code 1604031000168103 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:forecastStatus.code | example | Pattern Value: SNOMED-CT Code 1604041000168107 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:forecastStatusPeriod.code | example | Pattern Value: SNOMED-CT Code 1604051000168109 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard

#### Constraints

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() |
inv-hpps-1 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.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() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Observation | C | 0..* | Observation | Health program participation summary observation Constraints: obs-6, obs-7
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business Identifier for observation
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final
Slices for category |  | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
category:hPCat |  | 1..1 | CodeableConcept | Health program Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program
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
code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Participation in Health Program (extensible)
subject | Σ | 1..1 | Reference(Patient) | Who and/or what the observation is about
focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made
effective[x] | Σ | 1..1 | dateTime | Date, and optionally time, this information is asserted as 'true'
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
value[x] | Σ C | 0..1 |  | Actual result
valueQuantity |  |  | Quantity |
valueCodeableConcept |  |  | CodeableConcept |
valueString |  |  | string |
valueBoolean |  |  | boolean |
valueInteger |  |  | integer |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueSampledData |  |  | SampledData |
valueTime |  |  | time |
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note |  | 0..* | Annotation | Comments about the observation
bodySite |  | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
method |  | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations.
specimen |  | 0..1 | Reference(Specimen) | Specimen used for this observation
device |  | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device
referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3
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 | C | 0..1 | SimpleQuantity | Low Range, if relevant
high | C | 0..1 | SimpleQuantity | High Range, if relevant
type |  | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
appliesTo |  | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
age |  | 0..1 | Range | Applicable age range, if relevant
text |  | 0..1 | string | Text based reference range in an observation
hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from
Slices for component | Σ C | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code Constraints: inv-hpps-1
component:All Slices |  |  |  | Content/Rules for all slices
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): Codes identifying names of simple observations.
value[x] | Σ | 0..1 |  | Actual component result
valueQuantity |  |  | Quantity |
valueCodeableConcept |  |  | CodeableConcept |
valueString |  |  | string |
valueBoolean |  |  | boolean |
valueInteger |  |  | integer |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueSampledData |  |  | SampledData |
valueTime |  |  | time |
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:participationStatus | Σ | 1..1 | BackboneElement | Current status of an individual's participation in a program
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603781000168102
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result Binding: Health Program Participation Status (required)
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:participationStatusPeriod | Σ | 0..1 | BackboneElement | Validity period for the program participation status
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603791000168104
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:notParticipantStatusReason | Σ | 0..* | BackboneElement | Reason for not participating
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603991000168102
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result Binding: Reason For Non Participation In Health Program (preferred)
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:lastAction | Σ | 0..1 | BackboneElement | Last program participation action
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604001000168105
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:lastActionDate | Σ | 0..1 | BackboneElement | Last program participation action date
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604011000168108
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:nextAction | Σ | 0..1 | BackboneElement | Next program participation action
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604021000168101
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:nextActionDate | Σ | 0..1 | BackboneElement | Next program participation action date
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604031000168103
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:forecastStatus | Σ | 0..1 | BackboneElement | Forecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604041000168107
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
value[x] | Σ | 0..1 | CodeableConcept | Actual component result
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
component:forecastStatusPeriod | Σ | 0..1 | BackboneElement | Validity period associated with forecast status
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): Codes identifying names of simple observations. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604051000168109
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
value[x] | Σ | 0..1 |  | Actual component result
valueDateTime |  |  | dateTime |
valuePeriod |  |  | Period |
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation |  | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange |  | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Observation.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Observation.status | required | Fixed Value: final `http://hl7.org/fhir/ValueSet/observation-status|4.0.1` From the FHIR Standard
Observation.category | preferred | ObservationCategoryCodes `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.category:hPCat | preferred | Pattern Value: program `http://hl7.org/fhir/ValueSet/observation-category` From the FHIR Standard
Observation.code | extensible | ParticipationinHealthProgram `https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1` From https://tx.ontoserver.csiro.au/fhir
Observation.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.bodySite | example | SNOMEDCTBodyStructures `http://hl7.org/fhir/ValueSet/body-site` From the FHIR Standard
Observation.method | example | ObservationMethods `http://hl7.org/fhir/ValueSet/observation-methods` From the FHIR Standard
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes `http://hl7.org/fhir/ValueSet/referencerange-meaning` From the FHIR Standard
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes `http://hl7.org/fhir/ValueSet/referencerange-appliesto` From the FHIR Standard
Observation.component.code | example | LOINCCodes(a valid code from LOINC) `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:participationStatus.code | example | Pattern Value: SNOMED-CT Code 1603781000168102 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:participationStatus.value[x] | required | HealthProgramParticipationStatus `https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component:participationStatus.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:participationStatus.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:participationStatusPeriod.code | example | Pattern Value: SNOMED-CT Code 1603791000168104 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:participationStatusPeriod.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:participationStatusPeriod.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:notParticipantStatusReason.code | example | Pattern Value: SNOMED-CT Code 1603991000168102 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:notParticipantStatusReason.value[x] | preferred | ReasonForNonParticipationInHealthProgram `https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1` From https://tx.ontoserver.csiro.au/fhir
Observation.component:notParticipantStatusReason.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:notParticipantStatusReason.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:lastAction.code | example | Pattern Value: SNOMED-CT Code 1604001000168105 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:lastAction.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:lastAction.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:lastActionDate.code | example | Pattern Value: SNOMED-CT Code 1604011000168108 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:lastActionDate.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:lastActionDate.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:nextAction.code | example | Pattern Value: SNOMED-CT Code 1604021000168101 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:nextAction.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:nextAction.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:nextActionDate.code | example | Pattern Value: SNOMED-CT Code 1604031000168103 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:nextActionDate.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:nextActionDate.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:forecastStatus.code | example | Pattern Value: SNOMED-CT Code 1604041000168107 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:forecastStatus.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:forecastStatus.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard
Observation.component:forecastStatusPeriod.code | example | Pattern Value: SNOMED-CT Code 1604051000168109 `http://hl7.org/fhir/ValueSet/observation-codes` From the FHIR Standard
Observation.component:forecastStatusPeriod.dataAbsentReason | extensible | DataAbsentReason `http://hl7.org/fhir/ValueSet/data-absent-reason` From the FHIR Standard
Observation.component:forecastStatusPeriod.interpretation | extensible | ObservationInterpretationCodes `http://hl7.org/fhir/ValueSet/observation-interpretation` From the FHIR Standard

#### Constraints

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() |
inv-hpps-1 | error | Observation.component | The component shall at least have a value or a data absent reason : value.exists() or dataAbsentReason.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() |

This structure is derived from Observation

Summary

Mandatory: 6 elements
Fixed: 1 element

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Observation.category
- The element 1 is sliced based on the value of Observation.component

Maturity: 0

Other representations of profile: CSV, Excel, Schematron