Australian Digital Health Agency FHIR Implementation Guide

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:

• ADHA Immunisation History List
• ADHA Medication Use List
• ADHA Prescription and or Dispense History List

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from List

Name	Flags	Card.	Type	Description & Constraints
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
title	S	0..1	string	Descriptive name for the list
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)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
List.emptyReason	required	NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-lst-01	error	List	The 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-02	error	List	If 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-03	error	List	If 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-04	error	List.subject	At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-05	error	List.entry	All 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-06	error	List.date	Date shall be at least to day : toString().length() >= 10

Name	Flags	Card.	Type	Description & Constraints
List	C	0..*	List	A list is a curated collection of resources 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		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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
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(Resource)	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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
List.status	required	Pattern: current http://hl7.org/fhir/ValueSet/list-status|4.0.1 from the FHIR Standard
List.mode	required	ListMode http://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard
List.code	example	ExampleUseCodesForList http://hl7.org/fhir/ValueSet/list-example-codes from the FHIR Standard
List.entry.flag	example	PatientMedicineChangeTypes http://hl7.org/fhir/ValueSet/list-item-flag from the FHIR Standard
List.emptyReason	required	NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-lst-01	error	List	The 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-02	error	List	If 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-03	error	List	If 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-04	error	List.subject	At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-05	error	List.entry	All 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-06	error	List.date	Date shall be at least to day : toString().length() >= 10

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
List.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
List.status	required	Pattern: current http://hl7.org/fhir/ValueSet/list-status|4.0.1 from the FHIR Standard
List.mode	required	ListMode http://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard
List.code	example	ExampleUseCodesForList http://hl7.org/fhir/ValueSet/list-example-codes from the FHIR Standard
List.orderedBy	preferred	ListOrderCodes http://hl7.org/fhir/ValueSet/list-order from the FHIR Standard
List.entry.flag	example	PatientMedicineChangeTypes http://hl7.org/fhir/ValueSet/list-item-flag from the FHIR Standard
List.entry.item.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
List.emptyReason	required	NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-lst-01	error	List	The 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-02	error	List	If 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-03	error	List	If 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-04	error	List.subject	At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-05	error	List.entry	All 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-06	error	List.date	Date shall be at least to day : toString().length() >= 10

Differential View

This structure is derived from List

Name	Flags	Card.	Type	Description & Constraints
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
title	S	0..1	string	Descriptive name for the list
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)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
List.emptyReason	required	NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-lst-01	error	List	The 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-02	error	List	If 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-03	error	List	If 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-04	error	List.subject	At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-05	error	List.entry	All 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-06	error	List.date	Date shall be at least to day : toString().length() >= 10

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
List	C	0..*	List	A list is a curated collection of resources 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		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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
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(Resource)	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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
List.status	required	Pattern: current http://hl7.org/fhir/ValueSet/list-status|4.0.1 from the FHIR Standard
List.mode	required	ListMode http://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard
List.code	example	ExampleUseCodesForList http://hl7.org/fhir/ValueSet/list-example-codes from the FHIR Standard
List.entry.flag	example	PatientMedicineChangeTypes http://hl7.org/fhir/ValueSet/list-item-flag from the FHIR Standard
List.emptyReason	required	NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-lst-01	error	List	The 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-02	error	List	If 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-03	error	List	If 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-04	error	List.subject	At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-05	error	List.entry	All 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-06	error	List.date	Date shall be at least to day : toString().length() >= 10

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
List.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
List.status	required	Pattern: current http://hl7.org/fhir/ValueSet/list-status|4.0.1 from the FHIR Standard
List.mode	required	ListMode http://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard
List.code	example	ExampleUseCodesForList http://hl7.org/fhir/ValueSet/list-example-codes from the FHIR Standard
List.orderedBy	preferred	ListOrderCodes http://hl7.org/fhir/ValueSet/list-order from the FHIR Standard
List.entry.flag	example	PatientMedicineChangeTypes http://hl7.org/fhir/ValueSet/list-item-flag from the FHIR Standard
List.entry.item.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
List.emptyReason	required	NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 from https://tx.ontoserver.csiro.au/fhir

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-dh-lst-01	error	List	The 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-02	error	List	If 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-03	error	List	If 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-04	error	List.subject	At least reference or a valid identifier shall be present : reference.exists() or identifier.where(system.count() + value.count() >1).exists()
inv-dh-lst-05	error	List.entry	All 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-06	error	List.date	Date shall be at least to day : toString().length() >= 10

This structure is derived from List

Summary

Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 14 elements

Structures

This structure refers to these other structures:

• ADHA Core Patient (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-patient-core-1)
• ADHA Core Encounter (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-encounter-core-1)
• ADHA Authoring PractitionerRole (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-practitionerrole-author-1)
• ADHA System Device (http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-device-system-1)

Extensions

This structure refers to these extensions:

• http://hl7.org.au/fhir/StructureDefinition/author-related-person

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.