AU Base Implementation Guide
4.1.2-preview - Preview Australia flag

This page is part of the Australian Base IG (v4.1.2-preview: AU Base) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Health Program Participation Summary

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-healthprogramparticipation Version: 4.1.2-preview
Standards status: Trial-use Maturity Level: 0 Computable Name: AUHealthProgramParticipationSummary

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. This resource includes SNOMED Clinical Terms™ (SNOMED CT®) which is used by permission of the International Health Terminology Standards Development Organisation (IHTSDO). All rights reserved. SNOMED CT®, was originally created by The College of American Pathologists. “SNOMED” and “SNOMED CT” are registered trademarks of the IHTSDO. The rights to use and implement or implementation of SNOMED CT content are limited to the extent it is necessary to allow for the end use of this material. No further rights are granted in respect of the International Release and no further use of any SNOMED CT content by any other party is permitted. All copies of this resource must include this copyright statement and all information contained in this statement.

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

Usage:

Formal Views of Profile Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationHealth program participation summary observation
... status 1..1coderegistered | preliminary | final | amended +
Fixed Value: final
... Slices for category 1..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
.... category:hPCat 1..1CodeableConceptHealth program
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: program
... code 1..1CodeableConceptType of observation (code / type)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible)
... effective[x] 1..1dateTimeDate, and optionally time, this information is asserted as 'true'
... Slices for component C1..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
inv-hpps-1: The component shall at least have a value or a data absent reason
.... component:participationStatus 1..1BackboneElementCurrent status of an individual's participation in a program
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603781000168102
..... value[x] 0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required)
.... component:participationStatusPeriod 0..1BackboneElementValidity period for the program participation status
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603791000168104
..... value[x] 0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:notParticipantStatusReason 0..*BackboneElementReason for not participating
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603991000168102
..... value[x] 0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (preferred)
.... component:lastAction 0..1BackboneElementLast program participation action
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604001000168105
..... value[x] 0..1CodeableConceptActual component result
.... component:lastActionDate 0..1BackboneElementLast program participation action date
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604011000168108
..... value[x] 0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:nextAction 0..1BackboneElementNext program participation action
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604021000168101
..... value[x] 0..1CodeableConceptActual component result
.... component:nextActionDate 0..1BackboneElementNext program participation action date
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604031000168103
..... value[x] 0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:forecastStatus 0..1BackboneElementForecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604041000168107
..... value[x] 0..1CodeableConceptActual component result
.... component:forecastStatusPeriod 0..1BackboneElementValidity period associated with forecast status
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604051000168109
..... value[x] 0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.codeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1
Observation.component:participationStatus.value[x]requiredhttps://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1
Observation.component:notParticipantStatusReason.value[x]preferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1

Constraints

IdGradePath(s)DetailsRequirements
inv-hpps-1errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationHealth program participation summary observation
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.


Fixed Value: final
.... category:hPCat 1..1CodeableConceptHealth program
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: program
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible)
... subject Σ1..1Reference(Patient)Who and/or what the observation is about
... effective[x] Σ1..1dateTimeDate, and optionally time, this information is asserted as 'true'
... Slices for component ΣC1..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
inv-hpps-1: The component shall at least have a value or a data absent reason
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... component:participationStatus Σ1..1BackboneElementCurrent status of an individual's participation in a program
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603781000168102
..... value[x] Σ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required)
.... component:participationStatusPeriod Σ0..1BackboneElementValidity period for the program participation status
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603791000168104
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:notParticipantStatusReason Σ0..*BackboneElementReason for not participating
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603991000168102
..... value[x] Σ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (preferred)
.... component:lastAction Σ0..1BackboneElementLast program participation action
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604001000168105
..... value[x] Σ0..1CodeableConceptActual component result
.... component:lastActionDate Σ0..1BackboneElementLast program participation action date
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604011000168108
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:nextAction Σ0..1BackboneElementNext program participation action
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604021000168101
..... value[x] Σ0..1CodeableConceptActual component result
.... component:nextActionDate Σ0..1BackboneElementNext program participation action date
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604031000168103
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:forecastStatus Σ0..1BackboneElementForecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604041000168107
..... value[x] Σ0..1CodeableConceptActual component result
.... component:forecastStatusPeriod Σ0..1BackboneElementValidity period associated with forecast status
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604051000168109
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredFixed Value: final
Observation.categorypreferredObservationCategoryCodes
Observation.category:hPCatpreferredPattern: program
Observation.codeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component:participationStatus.codeexamplePattern: SNOMED CT code 1603781000168102
Observation.component:participationStatus.value[x]requiredhttps://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1
Observation.component:participationStatusPeriod.codeexamplePattern: SNOMED CT code 1603791000168104
Observation.component:notParticipantStatusReason.codeexamplePattern: SNOMED CT code 1603991000168102
Observation.component:notParticipantStatusReason.value[x]preferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1
Observation.component:lastAction.codeexamplePattern: SNOMED CT code 1604001000168105
Observation.component:lastActionDate.codeexamplePattern: SNOMED CT code 1604011000168108
Observation.component:nextAction.codeexamplePattern: SNOMED CT code 1604021000168101
Observation.component:nextActionDate.codeexamplePattern: SNOMED CT code 1604031000168103
Observation.component:forecastStatus.codeexamplePattern: SNOMED CT code 1604041000168107
Observation.component:forecastStatusPeriod.codeexamplePattern: SNOMED CT code 1604051000168109

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-hpps-1errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationHealth program participation summary observation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness 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..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.


Fixed Value: final
... Slices for category 1..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:hPCat 1..1CodeableConceptHealth program
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: program
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible)
... subject Σ1..1Reference(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..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] Σ1..1dateTimeDate, and optionally time, this information is asserted as 'true'
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣC0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason C0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange C0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low C0..1SimpleQuantityLow Range, if relevant
.... high C0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText 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 ΣC1..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
inv-hpps-1: The component shall at least have a value or a data absent reason
.... component:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ0..1Actual component result
...... valueQuantityQuantity
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementCurrent status of an individual's participation in a program
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603781000168102
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required)
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementValidity period for the program participation status
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603791000168104
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..*BackboneElementReason for not participating
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603991000168102
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (preferred)
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementLast program participation action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604001000168105
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1CodeableConceptActual component result
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementLast program participation action date
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604011000168108
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementNext program participation action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604021000168101
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1CodeableConceptActual component result
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementNext program participation action date
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604031000168103
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementForecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604041000168107
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1CodeableConceptActual component result
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementValidity period associated with forecast status
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604051000168109
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredFixed Value: final
Observation.categorypreferredObservationCategoryCodes
Observation.category:hPCatpreferredPattern: program
Observation.codeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes
Observation.component:participationStatus.codeexamplePattern: SNOMED CT code 1603781000168102
Observation.component:participationStatus.value[x]requiredhttps://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1
Observation.component:participationStatus.dataAbsentReasonextensibleDataAbsentReason
Observation.component:participationStatus.interpretationextensibleObservationInterpretationCodes
Observation.component:participationStatusPeriod.codeexamplePattern: SNOMED CT code 1603791000168104
Observation.component:participationStatusPeriod.dataAbsentReasonextensibleDataAbsentReason
Observation.component:participationStatusPeriod.interpretationextensibleObservationInterpretationCodes
Observation.component:notParticipantStatusReason.codeexamplePattern: SNOMED CT code 1603991000168102
Observation.component:notParticipantStatusReason.value[x]preferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1
Observation.component:notParticipantStatusReason.dataAbsentReasonextensibleDataAbsentReason
Observation.component:notParticipantStatusReason.interpretationextensibleObservationInterpretationCodes
Observation.component:lastAction.codeexamplePattern: SNOMED CT code 1604001000168105
Observation.component:lastAction.dataAbsentReasonextensibleDataAbsentReason
Observation.component:lastAction.interpretationextensibleObservationInterpretationCodes
Observation.component:lastActionDate.codeexamplePattern: SNOMED CT code 1604011000168108
Observation.component:lastActionDate.dataAbsentReasonextensibleDataAbsentReason
Observation.component:lastActionDate.interpretationextensibleObservationInterpretationCodes
Observation.component:nextAction.codeexamplePattern: SNOMED CT code 1604021000168101
Observation.component:nextAction.dataAbsentReasonextensibleDataAbsentReason
Observation.component:nextAction.interpretationextensibleObservationInterpretationCodes
Observation.component:nextActionDate.codeexamplePattern: SNOMED CT code 1604031000168103
Observation.component:nextActionDate.dataAbsentReasonextensibleDataAbsentReason
Observation.component:nextActionDate.interpretationextensibleObservationInterpretationCodes
Observation.component:forecastStatus.codeexamplePattern: SNOMED CT code 1604041000168107
Observation.component:forecastStatus.dataAbsentReasonextensibleDataAbsentReason
Observation.component:forecastStatus.interpretationextensibleObservationInterpretationCodes
Observation.component:forecastStatusPeriod.codeexamplePattern: SNOMED CT code 1604051000168109
Observation.component:forecastStatusPeriod.dataAbsentReasonextensibleDataAbsentReason
Observation.component:forecastStatusPeriod.interpretationextensibleObservationInterpretationCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-hpps-1errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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 Value: 1 element

Slices

This structure defines the following Slices:

  • The element Observation.category is sliced based on the value of pattern:$this
  • The element Observation.component is sliced based on the value of pattern:code

Maturity: 0

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationHealth program participation summary observation
... status 1..1coderegistered | preliminary | final | amended +
Fixed Value: final
... Slices for category 1..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
.... category:hPCat 1..1CodeableConceptHealth program
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: program
... code 1..1CodeableConceptType of observation (code / type)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible)
... effective[x] 1..1dateTimeDate, and optionally time, this information is asserted as 'true'
... Slices for component C1..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
inv-hpps-1: The component shall at least have a value or a data absent reason
.... component:participationStatus 1..1BackboneElementCurrent status of an individual's participation in a program
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603781000168102
..... value[x] 0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required)
.... component:participationStatusPeriod 0..1BackboneElementValidity period for the program participation status
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603791000168104
..... value[x] 0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:notParticipantStatusReason 0..*BackboneElementReason for not participating
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603991000168102
..... value[x] 0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (preferred)
.... component:lastAction 0..1BackboneElementLast program participation action
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604001000168105
..... value[x] 0..1CodeableConceptActual component result
.... component:lastActionDate 0..1BackboneElementLast program participation action date
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604011000168108
..... value[x] 0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:nextAction 0..1BackboneElementNext program participation action
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604021000168101
..... value[x] 0..1CodeableConceptActual component result
.... component:nextActionDate 0..1BackboneElementNext program participation action date
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604031000168103
..... value[x] 0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:forecastStatus 0..1BackboneElementForecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604041000168107
..... value[x] 0..1CodeableConceptActual component result
.... component:forecastStatusPeriod 0..1BackboneElementValidity period associated with forecast status
..... code 1..1CodeableConceptType of component observation (code / type)
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604051000168109
..... value[x] 0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.codeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1
Observation.component:participationStatus.value[x]requiredhttps://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1
Observation.component:notParticipantStatusReason.value[x]preferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1

Constraints

IdGradePath(s)DetailsRequirements
inv-hpps-1errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationHealth program participation summary observation
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.


Fixed Value: final
.... category:hPCat 1..1CodeableConceptHealth program
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: program
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible)
... subject Σ1..1Reference(Patient)Who and/or what the observation is about
... effective[x] Σ1..1dateTimeDate, and optionally time, this information is asserted as 'true'
... Slices for component ΣC1..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
inv-hpps-1: The component shall at least have a value or a data absent reason
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... component:participationStatus Σ1..1BackboneElementCurrent status of an individual's participation in a program
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603781000168102
..... value[x] Σ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required)
.... component:participationStatusPeriod Σ0..1BackboneElementValidity period for the program participation status
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603791000168104
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:notParticipantStatusReason Σ0..*BackboneElementReason for not participating
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603991000168102
..... value[x] Σ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (preferred)
.... component:lastAction Σ0..1BackboneElementLast program participation action
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604001000168105
..... value[x] Σ0..1CodeableConceptActual component result
.... component:lastActionDate Σ0..1BackboneElementLast program participation action date
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604011000168108
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:nextAction Σ0..1BackboneElementNext program participation action
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604021000168101
..... value[x] Σ0..1CodeableConceptActual component result
.... component:nextActionDate Σ0..1BackboneElementNext program participation action date
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604031000168103
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:forecastStatus Σ0..1BackboneElementForecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604041000168107
..... value[x] Σ0..1CodeableConceptActual component result
.... component:forecastStatusPeriod Σ0..1BackboneElementValidity period associated with forecast status
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604051000168109
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredFixed Value: final
Observation.categorypreferredObservationCategoryCodes
Observation.category:hPCatpreferredPattern: program
Observation.codeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component:participationStatus.codeexamplePattern: SNOMED CT code 1603781000168102
Observation.component:participationStatus.value[x]requiredhttps://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1
Observation.component:participationStatusPeriod.codeexamplePattern: SNOMED CT code 1603791000168104
Observation.component:notParticipantStatusReason.codeexamplePattern: SNOMED CT code 1603991000168102
Observation.component:notParticipantStatusReason.value[x]preferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1
Observation.component:lastAction.codeexamplePattern: SNOMED CT code 1604001000168105
Observation.component:lastActionDate.codeexamplePattern: SNOMED CT code 1604011000168108
Observation.component:nextAction.codeexamplePattern: SNOMED CT code 1604021000168101
Observation.component:nextActionDate.codeexamplePattern: SNOMED CT code 1604031000168103
Observation.component:forecastStatus.codeexamplePattern: SNOMED CT code 1604041000168107
Observation.component:forecastStatusPeriod.codeexamplePattern: SNOMED CT code 1604051000168109

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-hpps-1errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationHealth program participation summary observation
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness 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..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.


Fixed Value: final
... Slices for category 1..*CodeableConceptClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:hPCat 1..1CodeableConceptHealth program
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: program
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible)
... subject Σ1..1Reference(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..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] Σ1..1dateTimeDate, and optionally time, this information is asserted as 'true'
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] ΣC0..1Actual result
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason C0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange C0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low C0..1SimpleQuantityLow Range, if relevant
.... high C0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText 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 ΣC1..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
inv-hpps-1: The component shall at least have a value or a data absent reason
.... component:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... value[x] Σ0..1Actual component result
...... valueQuantityQuantity
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementCurrent status of an individual's participation in a program
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603781000168102
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required)
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementValidity period for the program participation status
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603791000168104
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..*BackboneElementReason for not participating
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1603991000168102
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (preferred)
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementLast program participation action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604001000168105
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1CodeableConceptActual component result
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementLast program participation action date
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604011000168108
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementNext program participation action
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604021000168101
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1CodeableConceptActual component result
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementNext program participation action date
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604031000168103
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementForecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604041000168107
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1CodeableConceptActual component result
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, 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..1BackboneElementValidity period associated with forecast status
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1604051000168109
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] Σ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
..... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

..... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


..... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredFixed Value: final
Observation.categorypreferredObservationCategoryCodes
Observation.category:hPCatpreferredPattern: program
Observation.codeextensiblehttps://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes
Observation.component:participationStatus.codeexamplePattern: SNOMED CT code 1603781000168102
Observation.component:participationStatus.value[x]requiredhttps://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1
Observation.component:participationStatus.dataAbsentReasonextensibleDataAbsentReason
Observation.component:participationStatus.interpretationextensibleObservationInterpretationCodes
Observation.component:participationStatusPeriod.codeexamplePattern: SNOMED CT code 1603791000168104
Observation.component:participationStatusPeriod.dataAbsentReasonextensibleDataAbsentReason
Observation.component:participationStatusPeriod.interpretationextensibleObservationInterpretationCodes
Observation.component:notParticipantStatusReason.codeexamplePattern: SNOMED CT code 1603991000168102
Observation.component:notParticipantStatusReason.value[x]preferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1
Observation.component:notParticipantStatusReason.dataAbsentReasonextensibleDataAbsentReason
Observation.component:notParticipantStatusReason.interpretationextensibleObservationInterpretationCodes
Observation.component:lastAction.codeexamplePattern: SNOMED CT code 1604001000168105
Observation.component:lastAction.dataAbsentReasonextensibleDataAbsentReason
Observation.component:lastAction.interpretationextensibleObservationInterpretationCodes
Observation.component:lastActionDate.codeexamplePattern: SNOMED CT code 1604011000168108
Observation.component:lastActionDate.dataAbsentReasonextensibleDataAbsentReason
Observation.component:lastActionDate.interpretationextensibleObservationInterpretationCodes
Observation.component:nextAction.codeexamplePattern: SNOMED CT code 1604021000168101
Observation.component:nextAction.dataAbsentReasonextensibleDataAbsentReason
Observation.component:nextAction.interpretationextensibleObservationInterpretationCodes
Observation.component:nextActionDate.codeexamplePattern: SNOMED CT code 1604031000168103
Observation.component:nextActionDate.dataAbsentReasonextensibleDataAbsentReason
Observation.component:nextActionDate.interpretationextensibleObservationInterpretationCodes
Observation.component:forecastStatus.codeexamplePattern: SNOMED CT code 1604041000168107
Observation.component:forecastStatus.dataAbsentReasonextensibleDataAbsentReason
Observation.component:forecastStatus.interpretationextensibleObservationInterpretationCodes
Observation.component:forecastStatusPeriod.codeexamplePattern: SNOMED CT code 1604051000168109
Observation.component:forecastStatusPeriod.dataAbsentReasonextensibleDataAbsentReason
Observation.component:forecastStatusPeriod.interpretationextensibleObservationInterpretationCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-hpps-1errorObservation.componentThe component shall at least have a value or a data absent reason
: value.exists() or dataAbsentReason.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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 Value: 1 element

Slices

This structure defines the following Slices:

  • The element Observation.category is sliced based on the value of pattern:$this
  • The element Observation.component is sliced based on the value of pattern:code

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron