Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-list-immunization-1 | Version: 0.0.1 | |||
| Draft as of 2024-12-19 | Computable Name: ADHAListImmunisation | |||
Copyright/Legal: Copyright © 2023 Australian Digital Health Agency - All rights reserved. Except for the material identified below, this content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. This material contains content from LOINC (http://loinc.org). LOINC is copyright © 1995-2022, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at http://loinc.org/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc. All copies of this resource must include this copyright statement and all information contained in this statement. |
||||
The purpose of this profile is to define a representation of list that describes a patient's immunisation history at a point in time for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia. The list may be partial, or complete, and may be scoped to a single source of vaccination information.
This profile identifies the additional constraints, extensions, and value sets that build on and extend List that are supported.
This profile is designed to set a List standard for:
This profile may be referred to by APIs, which will be listed here when available.
None.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ADHAListCore
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  List |
0..* | ADHAListCore | Immunisation history at a point in time for a patient | |
  code |
1..1 | CodeableConcept | What the purpose of this list is 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://loinc.org | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11369-6 | |
| entry |
0..* | BackboneElement | Entries in the list | |
 item |
1..1 | Reference(ADHA Core Immunization | AU Assertion of No Relevant Finding) | Actual entry | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List |
C | 0..* | ADHAListCore | Immunisation history at a point in time for a patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working" inv-dh-lst-01: The list shall have at least a source or a source relating person inv-dh-lst-02: If present, a source shall at least have a reference or a valid identifier inv-dh-lst-03: If present, a source related person (author-related-person) shall at least have a reference or a valid identifier |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 Slices for extension |
Content/Rules for all slices | |||
  sourceRelatedPerson |
SC | 0..1 | Reference(RelatedPerson) | Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 identifier |
S | 0..* | Identifier | Business identifier ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. ele-1: All FHIR elements must have a @value or children Required Pattern: current |
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 0..1 | string | Descriptive name for the list ele-1: All FHIR elements must have a @value or children Example General: Dr. Jane's Patients |
| code |
SΣ | 1..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. ele-1: All FHIR elements must have a @value or children 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://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11369-6 | |
| subject |
SΣC | 1..1 | Reference(ADHA Core Patient) | If all resources have the same subject ele-1: All FHIR elements must have a @value or children inv-dh-lst-04: At least reference or a valid identifier shall be present |
| encounter |
S | 0..1 | Reference(ADHA Core Encounter) | Context in which list created ele-1: All FHIR elements must have a @value or children |
| date |
SΣC | 1..1 | dateTime | When the list was prepared ele-1: All FHIR elements must have a @value or children inv-dh-lst-06: Date shall be at least to day |
| source |
SΣC | 0..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA System Device) | Who and/or what defined the list contents (aka Author) ele-1: All FHIR elements must have a @value or children |
| note |
S | 0..* | Annotation | Comments about the list ele-1: All FHIR elements must have a @value or children |
| entry |
SC | 0..* | BackboneElement | Entries in the list ele-1: All FHIR elements must have a @value or children inv-dh-lst-05: All observations shall conform to ADHA Simple Observation |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| flag |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. ele-1: All FHIR elements must have a @value or children |
| deleted |
?!C | 0..1 | boolean | If this item is actually marked as deleted ele-1: All FHIR elements must have a @value or children |
| item |
SC | 1..1 | Reference(ADHA Core Immunization | AU Assertion of No Relevant Finding) | Actual entry ele-1: All FHIR elements must have a @value or children |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| emptyReason |
SC | 0..1 | CodeableConcept | Why list is empty Binding: Non-Clinical Empty Reason  (required)ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| List.status | required | Pattern: currenthttp://hl7.org/fhir/ValueSet/list-status|4.0.1from the FHIR Standard | |
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | |
| List.code | example | Pattern: LOINC Code 11369-6http://hl7.org/fhir/ValueSet/list-example-codesfrom the FHIR Standard | |
| List.entry.flag | example | PatientMedicineChangeTypeshttp://hl7.org/fhir/ValueSet/list-item-flagfrom the FHIR Standard | |
| List.emptyReason | required | NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List |
C | 0..* | ADHAListCore | Immunisation history at a point in time for a patient lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working" inv-dh-lst-01: The list shall have at least a source or a source relating person inv-dh-lst-02: If present, a source shall at least have a reference or a valid identifier inv-dh-lst-03: If present, a source related person (author-related-person) shall at least have a reference or a valid identifier | ||||
| 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 | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| sourceRelatedPerson |
SC | 0..1 | Reference(RelatedPerson) | Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
S | 0..* | Identifier | Business identifier | ||||
| status |
?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Required Pattern: current | ||||
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. | ||||
| title |
SΣ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients | ||||
| code |
SΣ | 1..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. 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://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11369-6 | |||||
| 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 | |||||
| subject |
SΣC | 1..1 | Reference(ADHA Core Patient) | If all resources have the same subject inv-dh-lst-04: At least reference or a valid identifier shall be present | ||||
| encounter |
S | 0..1 | Reference(ADHA Core Encounter) | Context in which list created | ||||
| date |
SΣC | 1..1 | dateTime | When the list was prepared inv-dh-lst-06: Date shall be at least to day | ||||
| source |
SΣC | 0..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA System Device) | Who and/or what defined the list contents (aka Author) | ||||
| orderedBy |
0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |||||
| note |
S | 0..* | Annotation | Comments about the list | ||||
| entry |
SC | 0..* | BackboneElement | Entries in the list inv-dh-lst-05: All observations shall conform to ADHA Simple Observation | ||||
| 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 | ||||
| flag |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. | ||||
| deleted |
?!C | 0..1 | boolean | If this item is actually marked as deleted | ||||
| date |
0..1 | dateTime | When item added to list | |||||
| item |
SC | 1..1 | Reference(ADHA Core Immunization | AU Assertion of No Relevant Finding) | Actual entry | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| emptyReason |
SC | 0..1 | CodeableConcept | Why list is empty Binding: Non-Clinical Empty Reason (required) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| List.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| List.status | required | Pattern: currenthttp://hl7.org/fhir/ValueSet/list-status|4.0.1from the FHIR Standard | ||||
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| List.code | example | Pattern: LOINC Code 11369-6http://hl7.org/fhir/ValueSet/list-example-codesfrom the FHIR Standard | ||||
| List.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| List.entry.flag | example | PatientMedicineChangeTypeshttp://hl7.org/fhir/ValueSet/list-item-flagfrom the FHIR Standard | ||||
| List.entry.item.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| List.emptyReason | required | NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 |
This structure is derived from ADHAListCore
Differential View
This structure is derived from ADHAListCore
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List |
0..* | ADHAListCore | Immunisation history at a point in time for a patient | |
| code |
1..1 | CodeableConcept | What the purpose of this list is 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://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11369-6 | |
| entry |
0..* | BackboneElement | Entries in the list | |
| item |
1..1 | Reference(ADHA Core Immunization | AU Assertion of No Relevant Finding) | Actual entry | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List |
C | 0..* | ADHAListCore | Immunisation history at a point in time for a patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working" inv-dh-lst-01: The list shall have at least a source or a source relating person inv-dh-lst-02: If present, a source shall at least have a reference or a valid identifier inv-dh-lst-03: If present, a source related person (author-related-person) shall at least have a reference or a valid identifier |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| sourceRelatedPerson |
SC | 0..1 | Reference(RelatedPerson) | Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier |
S | 0..* | Identifier | Business identifier ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. ele-1: All FHIR elements must have a @value or children Required Pattern: current |
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 0..1 | string | Descriptive name for the list ele-1: All FHIR elements must have a @value or children Example General: Dr. Jane's Patients |
| code |
SΣ | 1..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. ele-1: All FHIR elements must have a @value or children 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://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11369-6 | |
| subject |
SΣC | 1..1 | Reference(ADHA Core Patient) | If all resources have the same subject ele-1: All FHIR elements must have a @value or children inv-dh-lst-04: At least reference or a valid identifier shall be present |
| encounter |
S | 0..1 | Reference(ADHA Core Encounter) | Context in which list created ele-1: All FHIR elements must have a @value or children |
| date |
SΣC | 1..1 | dateTime | When the list was prepared ele-1: All FHIR elements must have a @value or children inv-dh-lst-06: Date shall be at least to day |
| source |
SΣC | 0..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA System Device) | Who and/or what defined the list contents (aka Author) ele-1: All FHIR elements must have a @value or children |
| note |
S | 0..* | Annotation | Comments about the list ele-1: All FHIR elements must have a @value or children |
| entry |
SC | 0..* | BackboneElement | Entries in the list ele-1: All FHIR elements must have a @value or children inv-dh-lst-05: All observations shall conform to ADHA Simple Observation |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| flag |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. ele-1: All FHIR elements must have a @value or children |
| deleted |
?!C | 0..1 | boolean | If this item is actually marked as deleted ele-1: All FHIR elements must have a @value or children |
| item |
SC | 1..1 | Reference(ADHA Core Immunization | AU Assertion of No Relevant Finding) | Actual entry ele-1: All FHIR elements must have a @value or children |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| emptyReason |
SC | 0..1 | CodeableConcept | Why list is empty Binding: Non-Clinical Empty Reason (required)ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| List.status | required | Pattern: currenthttp://hl7.org/fhir/ValueSet/list-status|4.0.1from the FHIR Standard | |
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | |
| List.code | example | Pattern: LOINC Code 11369-6http://hl7.org/fhir/ValueSet/list-example-codesfrom the FHIR Standard | |
| List.entry.flag | example | PatientMedicineChangeTypeshttp://hl7.org/fhir/ValueSet/list-item-flagfrom the FHIR Standard | |
| List.emptyReason | required | NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List |
C | 0..* | ADHAListCore | Immunisation history at a point in time for a patient lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working" inv-dh-lst-01: The list shall have at least a source or a source relating person inv-dh-lst-02: If present, a source shall at least have a reference or a valid identifier inv-dh-lst-03: If present, a source related person (author-related-person) shall at least have a reference or a valid identifier | ||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| sourceRelatedPerson |
SC | 0..1 | Reference(RelatedPerson) | Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
S | 0..* | Identifier | Business identifier | ||||
| status |
?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Required Pattern: current | ||||
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. | ||||
| title |
SΣ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients | ||||
| code |
SΣ | 1..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. 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://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11369-6 | |||||
| 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 | |||||
| subject |
SΣC | 1..1 | Reference(ADHA Core Patient) | If all resources have the same subject inv-dh-lst-04: At least reference or a valid identifier shall be present | ||||
| encounter |
S | 0..1 | Reference(ADHA Core Encounter) | Context in which list created | ||||
| date |
SΣC | 1..1 | dateTime | When the list was prepared inv-dh-lst-06: Date shall be at least to day | ||||
| source |
SΣC | 0..1 | Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA System Device) | Who and/or what defined the list contents (aka Author) | ||||
| orderedBy |
0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |||||
| note |
S | 0..* | Annotation | Comments about the list | ||||
| entry |
SC | 0..* | BackboneElement | Entries in the list inv-dh-lst-05: All observations shall conform to ADHA Simple Observation | ||||
| 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 | ||||
| flag |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. | ||||
| deleted |
?!C | 0..1 | boolean | If this item is actually marked as deleted | ||||
| date |
0..1 | dateTime | When item added to list | |||||
| item |
SC | 1..1 | Reference(ADHA Core Immunization | AU Assertion of No Relevant Finding) | Actual entry | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| emptyReason |
SC | 0..1 | CodeableConcept | Why list is empty Binding: Non-Clinical Empty Reason (required) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| List.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| List.status | required | Pattern: currenthttp://hl7.org/fhir/ValueSet/list-status|4.0.1from the FHIR Standard | ||||
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| List.code | example | Pattern: LOINC Code 11369-6http://hl7.org/fhir/ValueSet/list-example-codesfrom the FHIR Standard | ||||
| List.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| List.entry.flag | example | PatientMedicineChangeTypeshttp://hl7.org/fhir/ValueSet/list-item-flagfrom the FHIR Standard | ||||
| List.entry.item.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| List.emptyReason | required | NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 |
This structure is derived from ADHAListCore
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-12-19
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
