AU Core Implementation Guide
0.2.1-preview - Preview Australia flag

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

Resource Profile: AU Core Health Program Participation Summary

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-healthprogramparticipation Version: 0.2.1-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreHealthProgramParticipationSummary

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; 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 sets minimum expectations for an Observation resource to record, search, and fetch information about a patient’s participation in a health program. It is based on the AU Base Health Program Participation Summary profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Observation when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for information about health programs a patient has participated in the past, is participating now, or will participate in the future
  • Record or update information about health programs associated with a patient

Comparison with other national and international specifications

A resource conforming to this profile is conformant to:

No equivalent International Patient Summary profile.

Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access or US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

  • Observation.category provides an efficient way of supporting system interactions, e.g. restricting searches. Implementers need to understand that data categorisation is somewhat subjective. The categorisation applied by the source may not align with a receiver’s expectations.
  • Additional codes that translate or map to the Observation code or category codes are allowed. For example providing both a local code and the required code.

  • Observation.code identifies the health program and nature of the observation (e.g. 1602081000168109 |National bowel cancer screening program participation| or 1602101000168102 |National cervical cancer screening program participation |)
  • Participant status is represented as a SNOMED CT-AU coded value in Observation.component.valueCodeableConcept with Observation.component.code= “1603781000168102”

Usage:

Formal Views of Profile Content

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

This structure is derived from AUHealthProgramParticipationSummary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*AUHealthProgramParticipationSummaryHealth program participation summary observation
... status S1..1coderegistered | preliminary | final | amended +
Fixed Value: final
... Slices for category S1..*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 S1..1CodeableConceptType of observation (code / type)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible)
... effective[x] SC1..1dateTimeDate, and optionally time, this information is asserted as 'true'
au-core-obs-01: Date shall be at least to day
... performer S0..*Reference(AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson)Who is responsible for the observation
... Slices for component 1..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
.... component:participationStatus S1..1BackboneElementCurrent status of an individual's participation in a program
..... code S1..1CodeableConceptType of component observation (code / type)
..... value[x] S0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required)
.... component:participationStatusPeriod S0..1BackboneElementValidity period for the program participation status
..... code S1..1CodeableConceptType of component observation (code / type)
..... value[x] S0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:notParticipantStatusReason S0..*BackboneElementReason for not participating
..... code S1..1CodeableConceptType of component observation (code / type)
..... value[x] S0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (extensible)

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]extensiblehttps://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: toString().length() >= 10
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*AUHealthProgramParticipationSummaryHealth program participation summary observation
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ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 SΣ1..1CodeableConceptType of observation (code / type)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible)
... subject SΣ1..1Reference(AU Core Patient)Who and/or what the observation is about
... effective[x] SΣC1..1dateTimeDate, and optionally time, this information is asserted as 'true'
au-core-obs-01: Date shall be at least to day
... performer SΣ0..*Reference(AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson)Who is responsible for the observation
... Slices for component ΣC1..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
.... 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 SΣ1..1BackboneElementCurrent status of an individual's participation in a program
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ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] SΣ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required)
.... component:participationStatusPeriod SΣ0..1BackboneElementValidity period for the program participation status
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ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] SΣ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:notParticipantStatusReason SΣ0..*BackboneElementReason for not participating
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ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] SΣ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (extensible)
.... 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
.... 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
.... 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
.... 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
.... 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
.... 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

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]extensiblehttps://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
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: toString().length() >= 10
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*AUHealthProgramParticipationSummaryHealth 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 ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.


Fixed Value: final
... Slices for category S1..*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 SΣ1..1CodeableConceptType of observation (code / type)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible)
... subject SΣ1..1Reference(AU Core Patient)Who and/or what the observation is about
... focus ΣTU0..*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] SΣC1..1dateTimeDate, and optionally time, this information is asserted as 'true'
au-core-obs-01: Date shall be at least to day
... issued Σ0..1instantDate/Time this version was made available
... performer SΣ0..*Reference(AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core 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
.... 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 SΣ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 SΣ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] SΣ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 SΣ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 SΣ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] SΣ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 SΣ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 SΣ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] SΣ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (extensible)
..... 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]extensiblehttps://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
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: toString().length() >= 10

This structure is derived from AUHealthProgramParticipationSummary

Summary

Mandatory: 4 elements
Must-Support: 15 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

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 AUHealthProgramParticipationSummary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*AUHealthProgramParticipationSummaryHealth program participation summary observation
... status S1..1coderegistered | preliminary | final | amended +
Fixed Value: final
... Slices for category S1..*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 S1..1CodeableConceptType of observation (code / type)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible)
... effective[x] SC1..1dateTimeDate, and optionally time, this information is asserted as 'true'
au-core-obs-01: Date shall be at least to day
... performer S0..*Reference(AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson)Who is responsible for the observation
... Slices for component 1..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
.... component:participationStatus S1..1BackboneElementCurrent status of an individual's participation in a program
..... code S1..1CodeableConceptType of component observation (code / type)
..... value[x] S0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required)
.... component:participationStatusPeriod S0..1BackboneElementValidity period for the program participation status
..... code S1..1CodeableConceptType of component observation (code / type)
..... value[x] S0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:notParticipantStatusReason S0..*BackboneElementReason for not participating
..... code S1..1CodeableConceptType of component observation (code / type)
..... value[x] S0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (extensible)

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]extensiblehttps://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1

Constraints

IdGradePath(s)DetailsRequirements
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: toString().length() >= 10

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*AUHealthProgramParticipationSummaryHealth program participation summary observation
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ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 SΣ1..1CodeableConceptType of observation (code / type)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible)
... subject SΣ1..1Reference(AU Core Patient)Who and/or what the observation is about
... effective[x] SΣC1..1dateTimeDate, and optionally time, this information is asserted as 'true'
au-core-obs-01: Date shall be at least to day
... performer SΣ0..*Reference(AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson)Who is responsible for the observation
... Slices for component ΣC1..*BackboneElementComponent results
Slice: Unordered, Open by pattern:code
.... 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 SΣ1..1BackboneElementCurrent status of an individual's participation in a program
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ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] SΣ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required)
.... component:participationStatusPeriod SΣ0..1BackboneElementValidity period for the program participation status
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ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] SΣ0..1Actual component result
...... valueDateTimedateTime
...... valuePeriodPeriod
.... component:notParticipantStatusReason SΣ0..*BackboneElementReason for not participating
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code SΣ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] SΣ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (extensible)
.... 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
.... 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
.... 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
.... 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
.... 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
.... 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

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]extensiblehttps://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
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: toString().length() >= 10

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*AUHealthProgramParticipationSummaryHealth 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 ?!SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.


Fixed Value: final
... Slices for category S1..*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 SΣ1..1CodeableConceptType of observation (code / type)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible)
... subject SΣ1..1Reference(AU Core Patient)Who and/or what the observation is about
... focus ΣTU0..*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] SΣC1..1dateTimeDate, and optionally time, this information is asserted as 'true'
au-core-obs-01: Date shall be at least to day
... issued Σ0..1instantDate/Time this version was made available
... performer SΣ0..*Reference(AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core 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
.... 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 SΣ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 SΣ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] SΣ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 SΣ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 SΣ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] SΣ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 SΣ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 SΣ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] SΣ0..1CodeableConceptActual component result
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (extensible)
..... 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]extensiblehttps://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
au-core-obs-01errorObservation.effective[x]Date shall be at least to day
: toString().length() >= 10

This structure is derived from AUHealthProgramParticipationSummary

Summary

Mandatory: 4 elements
Must-Support: 15 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

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

Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
patient SHALL reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
patient+category SHALL reference+token
patient+category+date SHALL reference+token+date
patient+code SHALL reference+token
patient+category+status SHOULD reference+token+token
patient+code+date SHOULD reference+token+date
patient.identifier SHOULD reference.token The client SHALL provide both the system and code values. The server SHALL support both. The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
category MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
code MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
date MAY date A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset.
status MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching using the patient search parameter:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Observation?patient={Type/}[id] or optionally GET [base]/Observation?patient.identifier=[system|][code]

    Example:

    1. GET [base]/Observation?patient=5678
    2. GET [base]/Observation?patient=5678&_revinclude=Provenance:target
    3. GET [base]/Observation?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    4. GET [base]/Observation?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient (how to search by reference and how to search by token)

  2. SHALL support searching using the combination of the patient and category search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Observation?patient={Type/}[id]&category={system|}[code]

    Example:

    1. GET [base]/Observation?patient=5678&category=http://terminology.hl7.org/CodeSystem/observation-category|survey

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category (how to search by reference and how to search by token)

  3. SHALL support searching using the combination of the patient and code search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)

    GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Observation?patient=5678&code=http://snomed.info/sct|1602091000168107,http://loinc.org|9279-1,http://loinc.org|85354-9

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and observation code(s). The Observation code parameter searches `Observation.code only. (how to search by reference and how to search by token)

  4. SHALL support searching using the combination of the patient and category and date search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support these date comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/Observation?patient={Type/}[id]&category={system|}[code]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/Observation?patient=5678&category=http://terminology.hl7.org/CodeSystem/observation-category|survey&date=ge2020-01-01T00:00:00Z

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and a category code = survey (how to search by reference and how to search by token and how to search by date)

Optional Search Parameters:

The following search parameters and search parameter combinations SHOULD be supported:

  1. SHOULD support searching using the combination of the patient and category and status search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHALL support multipleOr search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/Observation?patient={Type/}[id]&category={system|}[code]&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/Observation?patient=5678&category=http://terminology.hl7.org/CodeSystem/observation-category|survey&status=final
    2. GET [base]/Observation?patient=5678&category=http://terminology.hl7.org/CodeSystem/observation-category|survey&status=final

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and category and status (how to search by reference and how to search by token)

  2. SHOULD support searching using the combination of the patient and code and date search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code]
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)
    • SHALL support these date comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/Observation?patient=5678&code=http://snomed.info/sct|1602091000168107,http://loinc.org|9279-1,http://loinc.org|85354-9&date=ge2020-01-01T00:00:00Z
    2. GET [base]/Observation?patient.identifier=http://example.org/fhir/mrn|12345&code=http://snomed.info/sct|1602091000168107,http://loinc.org|9279-1,http://loinc.org|85354-9&date=ge2020-01-01T00:00:00Z

    Implementation Notes: Fetches a bundle of all Observation resources for the specified patient and date and report code(s). (how to search by reference and how to search by token and how to search by date)