Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access List resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

This structure is derived from List

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
List		0..*	List	A list is a curated collection of resources
identifier		0..*	Identifier	Business identifier
status		1..1	code	current | retired | entered-in-error
mode		1..1	code	working | snapshot | changes
title		0..1	string	Descriptive name for the list
code		0..1	CodeableConcept	What the purpose of this list is
subject		0..1	Reference(Patient | Group | Device | Location)	If all resources have the same subject
encounter		0..1	Reference(Encounter)	Context in which list created
date		0..1	dateTime	When the list was prepared
source		0..1	Reference(Practitioner | Patient | Device | PractitionerRole)	Who and/or what defined the list contents (aka Author)
orderedBy		0..1	CodeableConcept	What order the list has
note		0..1	Annotation	Comments about the list
entry		0..*	BackboneElement	Entries in the list
flag		0..1	CodeableConcept	Status/Workflow information about this item
deleted		0..1	boolean	If this item is actually marked as deleted
date		0..1	dateTime	When item added to list
item		1..1	Reference(Resource)	Actual entry
emptyReason		0..1	CodeableConcept	Why list is empty
Documentation for this format

This structure is derived from List

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
List	C	0..*	List	A list is a curated collection of resources Constraints: lst-1, lst-2, lst-3
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!Σ	1..1	code	current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
mode	?!Σ	1..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list.
title	Σ	0..1	string	Descriptive name for the list Example General: Dr. Jane's Patients
code	Σ	0..1	CodeableConcept	What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is.
subject	Σ	0..1	Reference(Patient | Group | Device | Location)	If all resources have the same subject
encounter		0..1	Reference(Encounter)	Context in which list created
date	Σ	0..1	dateTime	When the list was prepared
source	Σ	0..1	Reference(Practitioner | Patient | Device | PractitionerRole)	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		0..1	Annotation	Comments about the list
entry	C	0..*	BackboneElement	Entries in the list
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
flag		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		1..1	Reference(Resource)	Actual entry
emptyReason	C	0..1	CodeableConcept	Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
List.status	required	ListStatus 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.emptyReason	preferred	ListEmptyReasons http://hl7.org/fhir/ValueSet/list-empty-reason From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	List	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	List	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	List	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	List	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	List	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
lst-1	error	List	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	List	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	List	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

Differential View

This structure is derived from List

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
List		0..*	List	A list is a curated collection of resources
identifier		0..*	Identifier	Business identifier
status		1..1	code	current | retired | entered-in-error
mode		1..1	code	working | snapshot | changes
title		0..1	string	Descriptive name for the list
code		0..1	CodeableConcept	What the purpose of this list is
subject		0..1	Reference(Patient | Group | Device | Location)	If all resources have the same subject
encounter		0..1	Reference(Encounter)	Context in which list created
date		0..1	dateTime	When the list was prepared
source		0..1	Reference(Practitioner | Patient | Device | PractitionerRole)	Who and/or what defined the list contents (aka Author)
orderedBy		0..1	CodeableConcept	What order the list has
note		0..1	Annotation	Comments about the list
entry		0..*	BackboneElement	Entries in the list
flag		0..1	CodeableConcept	Status/Workflow information about this item
deleted		0..1	boolean	If this item is actually marked as deleted
date		0..1	dateTime	When item added to list
item		1..1	Reference(Resource)	Actual entry
emptyReason		0..1	CodeableConcept	Why list is empty
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
List	C	0..*	List	A list is a curated collection of resources Constraints: lst-1, lst-2, lst-3
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!Σ	1..1	code	current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
mode	?!Σ	1..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list.
title	Σ	0..1	string	Descriptive name for the list Example General: Dr. Jane's Patients
code	Σ	0..1	CodeableConcept	What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is.
subject	Σ	0..1	Reference(Patient | Group | Device | Location)	If all resources have the same subject
encounter		0..1	Reference(Encounter)	Context in which list created
date	Σ	0..1	dateTime	When the list was prepared
source	Σ	0..1	Reference(Practitioner | Patient | Device | PractitionerRole)	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		0..1	Annotation	Comments about the list
entry	C	0..*	BackboneElement	Entries in the list
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		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		1..1	Reference(Resource)	Actual entry
emptyReason	C	0..1	CodeableConcept	Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
List.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
List.status	required	ListStatus 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.emptyReason	preferred	ListEmptyReasons http://hl7.org/fhir/ValueSet/list-empty-reason From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	List	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	List	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	List	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	List	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	List	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
lst-1	error	List	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	List	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	List	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

This structure is derived from List