AU Core Implementation Guide
0.2.2-preview - Preview
AU Core Implementation Guide
0.2.2-preview - Preview
This page is part of the Australian Core IG (v0.2.2-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-healthprogramparticipation | Version: 0.2.2-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.
The following are supported usage scenarios for this profile:
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.
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 |)Observation.component.valueCodeableConcept with Observation.component.code= “1603781000168102”Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUHealthProgramParticipationSummary
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | AUHealthProgramParticipationSummary | Health program participation summary observation | |
  status | S | 1..1 | code | registered | preliminary | final | amended + Fixed Value: final |
  Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this |
   category:hPCat | 1..1 | CodeableConcept | Health program Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
| code | S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible) |
 subject | S | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about |
 effective[x] | SC | 1..1 | dateTime | Date, 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 | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code | |
 component:participationStatus | S | 1..1 | BackboneElement | Current status of an individual's participation in a program |
  code | S | 1..1 | CodeableConcept | Type of component observation (code / type) |
  value[x] | S | 0..1 | CodeableConcept | Actual component result Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required) |
| component:participationStatusPeriod | S | 0..1 | BackboneElement | Validity period for the program participation status |
| code | S | 1..1 | CodeableConcept | Type of component observation (code / type) |
 value[x] | S | 0..1 | Actual component result | |
| valueDateTime | dateTime | |||
| valuePeriod | Period | |||
| component:notParticipantStatusReason | S | 0..* | BackboneElement | Reason for not participating |
| code | S | 1..1 | CodeableConcept | Type of component observation (code / type) |
| value[x] | S | 0..1 | CodeableConcept | Actual component result Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.code | extensible | https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 |
| Observation.component:participationStatus.value[x] | required | https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 |
| Observation.component:notParticipantStatusReason.value[x] | extensible | https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : toString().length() >= 10 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | AUHealthProgramParticipationSummary | Health program participation summary observation |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final |
| Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
| category:hPCat | 1..1 | CodeableConcept | Health program Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
| code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible) |
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about |
| effective[x] | SΣC | 1..1 | dateTime | Date, 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 | ΣC | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code |
| component:All Slices | Content/Rules for all slices | |||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| component:participationStatus | SΣ | 1..1 | BackboneElement | Current status of an individual's participation in a program |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603781000168102 | |
| value[x] | SΣ | 0..1 | CodeableConcept | Actual component result Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required) |
| component:participationStatusPeriod | SΣ | 0..1 | BackboneElement | Validity period for the program participation status |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603791000168104 | |
| value[x] | SΣ | 0..1 | Actual component result | |
| valueDateTime | dateTime | |||
| valuePeriod | Period | |||
| component:notParticipantStatusReason | SΣ | 0..* | BackboneElement | Reason for not participating |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603991000168102 | |
| value[x] | SΣ | 0..1 | CodeableConcept | Actual component result Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (extensible) |
| component:lastAction | Σ | 0..1 | BackboneElement | Last program participation action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604001000168105 | |
| component:lastActionDate | Σ | 0..1 | BackboneElement | Last program participation action date |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604011000168108 | |
| component:nextAction | Σ | 0..1 | BackboneElement | Next program participation action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604021000168101 | |
| component:nextActionDate | Σ | 0..1 | BackboneElement | Next program participation action date |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604031000168103 | |
| component:forecastStatus | Σ | 0..1 | BackboneElement | Forecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604041000168107 | |
| component:forecastStatusPeriod | Σ | 0..1 | BackboneElement | Validity period associated with forecast status |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604051000168109 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.status | required | Fixed Value: final |
| Observation.category | preferred | ObservationCategoryCodes |
| Observation.category:hPCat | preferred | Pattern: program |
| Observation.code | extensible | https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.component:participationStatus.code | example | Pattern: SNOMED CT code 1603781000168102 |
| Observation.component:participationStatus.value[x] | required | https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 |
| Observation.component:participationStatusPeriod.code | example | Pattern: SNOMED CT code 1603791000168104 |
| Observation.component:notParticipantStatusReason.code | example | Pattern: SNOMED CT code 1603991000168102 |
| Observation.component:notParticipantStatusReason.value[x] | extensible | https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 |
| Observation.component:lastAction.code | example | Pattern: SNOMED CT code 1604001000168105 |
| Observation.component:lastActionDate.code | example | Pattern: SNOMED CT code 1604011000168108 |
| Observation.component:nextAction.code | example | Pattern: SNOMED CT code 1604021000168101 |
| Observation.component:nextActionDate.code | example | Pattern: SNOMED CT code 1604031000168103 |
| Observation.component:forecastStatus.code | example | Pattern: SNOMED CT code 1604041000168107 |
| Observation.component:forecastStatusPeriod.code | example | Pattern: SNOMED CT code 1604051000168109 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : toString().length() >= 10 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | AUHealthProgramParticipationSummary | Health program participation summary observation | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final | ||||
| Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
| category:hPCat | 1..1 | CodeableConcept | Health program Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible) | ||||
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about | ||||
| focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] | SΣC | 1..1 | dateTime | Date, and optionally time, this information is asserted as 'true' au-core-obs-01: Date shall be at least to day | ||||
| issued | Σ | 0..1 | instant | Date/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] | ΣC | 0..1 | Actual result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note | 0..* | Annotation | Comments about the observation | |||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age | 0..1 | Range | Applicable age range, if relevant | |||||
| text | 0..1 | string | Text based reference range in an observation | |||||
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| Slices for component | ΣC | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code | ||||
| component:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:participationStatus | SΣ | 1..1 | BackboneElement | Current status of an individual's participation in a program | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603781000168102 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | SΣ | 0..1 | CodeableConcept | Actual component result Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required) | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:participationStatusPeriod | SΣ | 0..1 | BackboneElement | Validity period for the program participation status | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603791000168104 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | SΣ | 0..1 | Actual component result | |||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:notParticipantStatusReason | SΣ | 0..* | BackboneElement | Reason for not participating | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603991000168102 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | SΣ | 0..1 | CodeableConcept | Actual component result Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (extensible) | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:lastAction | Σ | 0..1 | BackboneElement | Last program participation action | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604001000168105 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | Σ | 0..1 | CodeableConcept | Actual component result | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:lastActionDate | Σ | 0..1 | BackboneElement | Last program participation action date | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604011000168108 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:nextAction | Σ | 0..1 | BackboneElement | Next program participation action | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604021000168101 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | Σ | 0..1 | CodeableConcept | Actual component result | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:nextActionDate | Σ | 0..1 | BackboneElement | Next program participation action date | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604031000168103 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:forecastStatus | Σ | 0..1 | BackboneElement | Forecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604041000168107 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | Σ | 0..1 | CodeableConcept | Actual component result | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:forecastStatusPeriod | Σ | 0..1 | BackboneElement | Validity period associated with forecast status | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604051000168109 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | Fixed Value: final | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.category:hPCat | preferred | Pattern: program | ||||
| Observation.code | extensible | https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
| Observation.method | example | ObservationMethods | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:participationStatus.code | example | Pattern: SNOMED CT code 1603781000168102 | ||||
| Observation.component:participationStatus.value[x] | required | https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 | ||||
| Observation.component:participationStatus.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:participationStatus.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:participationStatusPeriod.code | example | Pattern: SNOMED CT code 1603791000168104 | ||||
| Observation.component:participationStatusPeriod.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:participationStatusPeriod.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:notParticipantStatusReason.code | example | Pattern: SNOMED CT code 1603991000168102 | ||||
| Observation.component:notParticipantStatusReason.value[x] | extensible | https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 | ||||
| Observation.component:notParticipantStatusReason.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:notParticipantStatusReason.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:lastAction.code | example | Pattern: SNOMED CT code 1604001000168105 | ||||
| Observation.component:lastAction.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:lastAction.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:lastActionDate.code | example | Pattern: SNOMED CT code 1604011000168108 | ||||
| Observation.component:lastActionDate.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:lastActionDate.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:nextAction.code | example | Pattern: SNOMED CT code 1604021000168101 | ||||
| Observation.component:nextAction.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:nextAction.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:nextActionDate.code | example | Pattern: SNOMED CT code 1604031000168103 | ||||
| Observation.component:nextActionDate.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:nextActionDate.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:forecastStatus.code | example | Pattern: SNOMED CT code 1604041000168107 | ||||
| Observation.component:forecastStatus.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:forecastStatus.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:forecastStatusPeriod.code | example | Pattern: SNOMED CT code 1604051000168109 | ||||
| Observation.component:forecastStatusPeriod.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:forecastStatusPeriod.interpretation | extensible | ObservationInterpretationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.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:
Maturity: 0
Differential View
This structure is derived from AUHealthProgramParticipationSummary
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | AUHealthProgramParticipationSummary | Health program participation summary observation | |
| status | S | 1..1 | code | registered | preliminary | final | amended + Fixed Value: final |
| Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this |
| category:hPCat | 1..1 | CodeableConcept | Health program Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
| code | S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible) |
| subject | S | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about |
| effective[x] | SC | 1..1 | dateTime | Date, 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 | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code | |
| component:participationStatus | S | 1..1 | BackboneElement | Current status of an individual's participation in a program |
| code | S | 1..1 | CodeableConcept | Type of component observation (code / type) |
| value[x] | S | 0..1 | CodeableConcept | Actual component result Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required) |
| component:participationStatusPeriod | S | 0..1 | BackboneElement | Validity period for the program participation status |
| code | S | 1..1 | CodeableConcept | Type of component observation (code / type) |
| value[x] | S | 0..1 | Actual component result | |
| valueDateTime | dateTime | |||
| valuePeriod | Period | |||
| component:notParticipantStatusReason | S | 0..* | BackboneElement | Reason for not participating |
| code | S | 1..1 | CodeableConcept | Type of component observation (code / type) |
| value[x] | S | 0..1 | CodeableConcept | Actual component result Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (extensible) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.code | extensible | https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 |
| Observation.component:participationStatus.value[x] | required | https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 |
| Observation.component:notParticipantStatusReason.value[x] | extensible | https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : toString().length() >= 10 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | AUHealthProgramParticipationSummary | Health program participation summary observation |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final |
| Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
| category:hPCat | 1..1 | CodeableConcept | Health program Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |
| code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible) |
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about |
| effective[x] | SΣC | 1..1 | dateTime | Date, 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 | ΣC | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code |
| component:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| component:participationStatus | SΣ | 1..1 | BackboneElement | Current status of an individual's participation in a program |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603781000168102 | |
| value[x] | SΣ | 0..1 | CodeableConcept | Actual component result Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required) |
| component:participationStatusPeriod | SΣ | 0..1 | BackboneElement | Validity period for the program participation status |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603791000168104 | |
| value[x] | SΣ | 0..1 | Actual component result | |
| valueDateTime | dateTime | |||
| valuePeriod | Period | |||
| component:notParticipantStatusReason | SΣ | 0..* | BackboneElement | Reason for not participating |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603991000168102 | |
| value[x] | SΣ | 0..1 | CodeableConcept | Actual component result Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (extensible) |
| component:lastAction | Σ | 0..1 | BackboneElement | Last program participation action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604001000168105 | |
| component:lastActionDate | Σ | 0..1 | BackboneElement | Last program participation action date |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604011000168108 | |
| component:nextAction | Σ | 0..1 | BackboneElement | Next program participation action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604021000168101 | |
| component:nextActionDate | Σ | 0..1 | BackboneElement | Next program participation action date |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604031000168103 | |
| component:forecastStatus | Σ | 0..1 | BackboneElement | Forecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604041000168107 | |
| component:forecastStatusPeriod | Σ | 0..1 | BackboneElement | Validity period associated with forecast status |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604051000168109 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.status | required | Fixed Value: final |
| Observation.category | preferred | ObservationCategoryCodes |
| Observation.category:hPCat | preferred | Pattern: program |
| Observation.code | extensible | https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.component:participationStatus.code | example | Pattern: SNOMED CT code 1603781000168102 |
| Observation.component:participationStatus.value[x] | required | https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 |
| Observation.component:participationStatusPeriod.code | example | Pattern: SNOMED CT code 1603791000168104 |
| Observation.component:notParticipantStatusReason.code | example | Pattern: SNOMED CT code 1603991000168102 |
| Observation.component:notParticipantStatusReason.value[x] | extensible | https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 |
| Observation.component:lastAction.code | example | Pattern: SNOMED CT code 1604001000168105 |
| Observation.component:lastActionDate.code | example | Pattern: SNOMED CT code 1604011000168108 |
| Observation.component:nextAction.code | example | Pattern: SNOMED CT code 1604021000168101 |
| Observation.component:nextActionDate.code | example | Pattern: SNOMED CT code 1604031000168103 |
| Observation.component:forecastStatus.code | example | Pattern: SNOMED CT code 1604041000168107 |
| Observation.component:forecastStatusPeriod.code | example | Pattern: SNOMED CT code 1604051000168109 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.effective[x] | Date shall be at least to day : toString().length() >= 10 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Observation | C | 0..* | AUHealthProgramParticipationSummary | Health program participation summary observation | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final | ||||
| Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:$this Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
| category:hPCat | 1..1 | CodeableConcept | Health program Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/observation-category | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: program | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 (extensible) | ||||
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Who and/or what the observation is about | ||||
| focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] | SΣC | 1..1 | dateTime | Date, and optionally time, this information is asserted as 'true' au-core-obs-01: Date shall be at least to day | ||||
| issued | Σ | 0..1 | instant | Date/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] | ΣC | 0..1 | Actual result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note | 0..* | Annotation | Comments about the observation | |||||
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
| referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
| high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
| age | 0..1 | Range | Applicable age range, if relevant | |||||
| text | 0..1 | string | Text based reference range in an observation | |||||
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| Slices for component | ΣC | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code | ||||
| component:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueSampledData | SampledData | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:participationStatus | SΣ | 1..1 | BackboneElement | Current status of an individual's participation in a program | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603781000168102 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | SΣ | 0..1 | CodeableConcept | Actual component result Binding: https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 (required) | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:participationStatusPeriod | SΣ | 0..1 | BackboneElement | Validity period for the program participation status | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603791000168104 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | SΣ | 0..1 | Actual component result | |||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:notParticipantStatusReason | SΣ | 0..* | BackboneElement | Reason for not participating | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | SΣ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1603991000168102 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | SΣ | 0..1 | CodeableConcept | Actual component result Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 (extensible) | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:lastAction | Σ | 0..1 | BackboneElement | Last program participation action | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604001000168105 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | Σ | 0..1 | CodeableConcept | Actual component result | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:lastActionDate | Σ | 0..1 | BackboneElement | Last program participation action date | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604011000168108 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:nextAction | Σ | 0..1 | BackboneElement | Next program participation action | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604021000168101 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | Σ | 0..1 | CodeableConcept | Actual component result | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:nextActionDate | Σ | 0..1 | BackboneElement | Next program participation action date | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604031000168103 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:forecastStatus | Σ | 0..1 | BackboneElement | Forecast status with reference to program pathway, e.g. overdue, as at the time this observation is asserted | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604041000168107 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | Σ | 0..1 | CodeableConcept | Actual component result | ||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| component:forecastStatusPeriod | Σ | 0..1 | BackboneElement | Validity period associated with forecast status | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1604051000168109 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | Σ | 0..1 | Actual component result | |||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | Fixed Value: final | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.category:hPCat | preferred | Pattern: program | ||||
| Observation.code | extensible | https://healthterminologies.gov.au/fhir/ValueSet/participation-in-health-program-1 | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructures | ||||
| Observation.method | example | ObservationMethods | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:participationStatus.code | example | Pattern: SNOMED CT code 1603781000168102 | ||||
| Observation.component:participationStatus.value[x] | required | https://healthterminologies.gov.au/fhir/ValueSet/health-program-participation-status-1 | ||||
| Observation.component:participationStatus.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:participationStatus.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:participationStatusPeriod.code | example | Pattern: SNOMED CT code 1603791000168104 | ||||
| Observation.component:participationStatusPeriod.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:participationStatusPeriod.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:notParticipantStatusReason.code | example | Pattern: SNOMED CT code 1603991000168102 | ||||
| Observation.component:notParticipantStatusReason.value[x] | extensible | https://healthterminologies.gov.au/fhir/ValueSet/reason-non-participation-health-program-1 | ||||
| Observation.component:notParticipantStatusReason.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:notParticipantStatusReason.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:lastAction.code | example | Pattern: SNOMED CT code 1604001000168105 | ||||
| Observation.component:lastAction.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:lastAction.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:lastActionDate.code | example | Pattern: SNOMED CT code 1604011000168108 | ||||
| Observation.component:lastActionDate.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:lastActionDate.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:nextAction.code | example | Pattern: SNOMED CT code 1604021000168101 | ||||
| Observation.component:nextAction.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:nextAction.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:nextActionDate.code | example | Pattern: SNOMED CT code 1604031000168103 | ||||
| Observation.component:nextActionDate.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:nextActionDate.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:forecastStatus.code | example | Pattern: SNOMED CT code 1604041000168107 | ||||
| Observation.component:forecastStatus.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:forecastStatus.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component:forecastStatusPeriod.code | example | Pattern: SNOMED CT code 1604051000168109 | ||||
| Observation.component:forecastStatusPeriod.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component:forecastStatusPeriod.interpretation | extensible | ObservationInterpretationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-obs-01 | error | Observation.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:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
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. |
The following search parameters and search parameter combinations SHALL be supported:
patient search parameter:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Observation?patient={Type/}[id] or optionally GET [base]/Observation?patient.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle of all Observation resources for the specified patient (how to search by reference and how to search by token)
patient and category search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Observation?patient={Type/}[id]&category={system|}[code]
Example:
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)
patient and code search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])code (e.g.code={system|}[code],{system|}[code],...)GET [base]/Observation?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}
Example:
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)
patient and category and date search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])date comparators: gt,lt,ge,ledate (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:
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)
The following search parameters and search parameter combinations SHOULD be supported:
patient and category and status search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code])status (e.g.status={system|}[code],{system|}[code],...)GET [base]/Observation?patient={Type/}[id]&category={system|}[code]&status={system|}[code]{,{system|}[code],...}
Example:
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)
patient and code and date search parameters:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code]code (e.g.code={system|}[code],{system|}[code],...)date comparators: gt,lt,ge,ledate (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:
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)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.2.2-preview based on FHIR 4.0.1. Generated 2023-11-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change