Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft Australia flag

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

Resource Profile: ADHA Core List ( Experimental )

Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-list-core-1 Version: 0.0.7
Draft as of 2024-09-12 Computable Name: ADHAListCore

Copyright/Legal: Copyright © 2022 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.

The purpose of this profile is to provide a core representation of a list for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.

This profile identifies the additional constraints, extensions, and value sets that build on and extend List that are supported.

Where a more specific List profile is applicable, e.g. prescription or dispense history list, an implementation SHALL ensure the resource conforms to that specific profile.

This profile is designed to set a core List standard for:

  • Query for a list associated with a patient
  • Record or update a list associated with a patient

This profile may be referred to by APIs, which will be listed here when available.

Profile specific guidance

None.

Boundaries and relationships

These profiles build on this profile (ADHA Core List) to define specific lists:

Usage:

Formal Views of Profile Content

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

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
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
... 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
... identifier S 0..* Identifier Business identifier
... status S 1..1 code current | retired | entered-in-error
Required Pattern: current
... code S 1..1 CodeableConcept What the purpose of this list is
... subject SC 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 SC 1..1 dateTime When the list was prepared
inv-dh-lst-06: Date shall be at least to day
... source SC 0..1 Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA System Device) Who and/or what defined the list contents (aka Author)
... 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
.... flag S 0..1 CodeableConcept Status/Workflow information about this item
.... item SC 1..1 Reference(Resource) Actual entry
..... reference 1..1 string Literal reference, Relative, internal or absolute URL
... emptyReason S 0..1 CodeableConcept Why list is empty
Binding: Non-Clinical Empty Reason . (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
List.emptyReasonrequiredNonClinicalEmptyReason .
https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-lst-01errorListThe list shall have at least a source or a source relating person
: source.exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').exists()
inv-dh-lst-02errorListIf present, a source shall at least have a reference or a valid identifier
: source.exists() implies source.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-lst-03errorListIf present, a source related person (author-related-person) shall at least have a reference or a valid identifier
: extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1').exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-04errorList.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-05errorList.entryAll observations shall conform to ADHA Simple Observation
: item.resolve().where($this is Observation).exists() implies item.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-observation-simple-1')
inv-dh-lst-06errorList.dateDate shall be at least to day
: toString().length() >= 10
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
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
... 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
... 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.

... 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)
... 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
.... 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
.... item SC 1..1 Reference(Resource) Actual entry
..... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... emptyReason SC 0..1 CodeableConcept Why list is empty
Binding: Non-Clinical Empty Reason . (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.codeexampleExampleUseCodesForList
http://hl7.org/fhir/ValueSet/list-example-codes
from the FHIR Standard
List.entry.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.emptyReasonrequiredNonClinicalEmptyReason .
https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-lst-01errorListThe list shall have at least a source or a source relating person
: source.exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').exists()
inv-dh-lst-02errorListIf present, a source shall at least have a reference or a valid identifier
: source.exists() implies source.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-lst-03errorListIf present, a source related person (author-related-person) shall at least have a reference or a valid identifier
: extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1').exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-04errorList.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-05errorList.entryAll observations shall conform to ADHA Simple Observation
: item.resolve().where($this is Observation).exists() implies item.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-observation-simple-1')
inv-dh-lst-06errorList.dateDate shall be at least to day
: toString().length() >= 10
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
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
... 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.

... 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(Resource) 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.codeexampleExampleUseCodesForList
http://hl7.org/fhir/ValueSet/list-example-codes
from the FHIR Standard
List.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
List.entry.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.entry.item.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
List.emptyReasonrequiredNonClinicalEmptyReason .
https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-lst-01errorListThe list shall have at least a source or a source relating person
: source.exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').exists()
inv-dh-lst-02errorListIf present, a source shall at least have a reference or a valid identifier
: source.exists() implies source.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-lst-03errorListIf present, a source related person (author-related-person) shall at least have a reference or a valid identifier
: extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1').exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-04errorList.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-05errorList.entryAll observations shall conform to ADHA Simple Observation
: item.resolve().where($this is Observation).exists() implies item.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-observation-simple-1')
inv-dh-lst-06errorList.dateDate shall be at least to day
: toString().length() >= 10

Differential View

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
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
... 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
... identifier S 0..* Identifier Business identifier
... status S 1..1 code current | retired | entered-in-error
Required Pattern: current
... code S 1..1 CodeableConcept What the purpose of this list is
... subject SC 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 SC 1..1 dateTime When the list was prepared
inv-dh-lst-06: Date shall be at least to day
... source SC 0..1 Reference(ADHA Authoring PractitionerRole | ADHA Core Patient | ADHA System Device) Who and/or what defined the list contents (aka Author)
... 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
.... flag S 0..1 CodeableConcept Status/Workflow information about this item
.... item SC 1..1 Reference(Resource) Actual entry
..... reference 1..1 string Literal reference, Relative, internal or absolute URL
... emptyReason S 0..1 CodeableConcept Why list is empty
Binding: Non-Clinical Empty Reason . (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
List.emptyReasonrequiredNonClinicalEmptyReason .
https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-lst-01errorListThe list shall have at least a source or a source relating person
: source.exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').exists()
inv-dh-lst-02errorListIf present, a source shall at least have a reference or a valid identifier
: source.exists() implies source.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-lst-03errorListIf present, a source related person (author-related-person) shall at least have a reference or a valid identifier
: extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1').exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-04errorList.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-05errorList.entryAll observations shall conform to ADHA Simple Observation
: item.resolve().where($this is Observation).exists() implies item.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-observation-simple-1')
inv-dh-lst-06errorList.dateDate shall be at least to day
: toString().length() >= 10

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
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
... 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
... 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.

... 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)
... 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
.... 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
.... item SC 1..1 Reference(Resource) Actual entry
..... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... emptyReason SC 0..1 CodeableConcept Why list is empty
Binding: Non-Clinical Empty Reason . (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.codeexampleExampleUseCodesForList
http://hl7.org/fhir/ValueSet/list-example-codes
from the FHIR Standard
List.entry.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.emptyReasonrequiredNonClinicalEmptyReason .
https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-lst-01errorListThe list shall have at least a source or a source relating person
: source.exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').exists()
inv-dh-lst-02errorListIf present, a source shall at least have a reference or a valid identifier
: source.exists() implies source.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-lst-03errorListIf present, a source related person (author-related-person) shall at least have a reference or a valid identifier
: extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1').exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-04errorList.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-05errorList.entryAll observations shall conform to ADHA Simple Observation
: item.resolve().where($this is Observation).exists() implies item.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-observation-simple-1')
inv-dh-lst-06errorList.dateDate shall be at least to day
: toString().length() >= 10

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
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
... 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.

... 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(Resource) 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.codeexampleExampleUseCodesForList
http://hl7.org/fhir/ValueSet/list-example-codes
from the FHIR Standard
List.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
List.entry.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.entry.item.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
List.emptyReasonrequiredNonClinicalEmptyReason .
https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2

Constraints

IdGradePath(s)DetailsRequirements
inv-dh-lst-01errorListThe list shall have at least a source or a source relating person
: source.exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').exists()
inv-dh-lst-02errorListIf present, a source shall at least have a reference or a valid identifier
: source.exists() implies source.all($this.reference.exists() or $this.display.exists() or $this.identifier.where(system.count() + value.count() >1).exists())
inv-dh-lst-03errorListIf present, a source related person (author-related-person) shall at least have a reference or a valid identifier
: extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-relatedperson-author-1').exists() or extension('http://hl7.org.au/fhir/StructureDefinition/author-related-person').valueReference.identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-04errorList.subjectAt least reference or a valid identifier shall be present
: reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-05errorList.entryAll observations shall conform to ADHA Simple Observation
: item.resolve().where($this is Observation).exists() implies item.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-observation-simple-1')
inv-dh-lst-06errorList.dateDate shall be at least to day
: toString().length() >= 10

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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.