Netherlands - Generic Functions for data exchange Implementation Guide
0.3.0 - ci-build Netherlands

Netherlands - Generic Functions for data exchange Implementation Guide, published by Stichting Nuts. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nuts-foundation/nl-generic-functions-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: NL Generic Functions Localization List Profile

Official URL: http://nuts-foundation.github.io/nl-generic-functions-ig/StructureDefinition/nl-gf-localization-list | Version: 0.3.0
Draft as of 2026-02-09 | Computable Name: NlGfLocalizationList

A List profile for registering the availability of patient data at healthcare organizations for localization services. This profile is used to indicate that certain patient data is available at a specific organization and can be accessed for localization purposes.

Usages:

- Examples for this Profile: List/a1b2c3d4-e5f6-7890-abcd-ef1234567890
- CapabilityStatements using this Profile: Localization Service (List)

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

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
Slices for identifier |  | 1..* | Identifier | Business identifier Slice: Unordered, Open by value:$this
identifier:AssignedId |  | 1..1 | Identifier | Business identifier
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
assigner | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
coding | Σ | 1..1 | Coding | Code defined by a terminology system
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type
code | Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: author
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/ura
value | Σ | 1..1 | string | The value that is unique Example General: 123456
status | ?!Σ | 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. Required Pattern: working
code | Σ | 1..1 | CodeableConcept | What the purpose of this list is Binding: urn:oid:2.16.840.1.113883.2.4.3.111.3.3.11.2 (required)
subject | Σ | 1..1 | Reference(Patient) | If all resources have the same subject
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/pseudo-bsn
source | Σ | 1..1 | Reference(Device) | Who and/or what defined the list contents (aka Author)
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). Required Pattern: Device
emptyReason | C | 1..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/list-empty-reason
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: withheld
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
List.identifier:AssignedId.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​assigner.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​assigner.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.status | Base | required | ListStatus | 📍4.0.1 | FHIR Std.
List.mode | Base | required | ListMode | 📍4.0.1 | FHIR Std.
List.code | Base | required | urn:oid:2.16.840.1.113883.2.4.3.111.3.3.11.2 | Not State | Unknown
List.subject.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.source.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.emptyReason | Base | preferred | List Empty Reasons | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
List |  | 0..* | List | A list is a curated collection of resources
Slices for identifier |  | 1..* | Identifier | Business identifier Slice: Unordered, Open by value:$this
identifier:AssignedId |  | 1..1 | Identifier | Business identifier
system |  | 1..1 | uri | The namespace for the identifier value
value |  | 1..1 | string | The value that is unique
assigner |  | 1..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier |  | 1..1 | Identifier | Logical reference, when literal reference is not known
type |  | 1..1 | CodeableConcept | Description of identifier
coding |  | 1..1 | Coding | Code defined by a terminology system
system |  | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type
code |  | 0..1 | code | Symbol in syntax defined by the system Required Pattern: author
system |  | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/ura
value |  | 1..1 | string | The value that is unique
status |  | 1..1 | code | current | retired | entered-in-error Required Pattern: current
mode |  | 1..1 | code | working | snapshot | changes Required Pattern: working
code |  | 1..1 | CodeableConcept | What the purpose of this list is Binding: urn:oid:2.16.840.1.113883.2.4.3.111.3.3.11.2 (required)
subject |  | 1..1 | Reference(Patient) | If all resources have the same subject
reference |  | 0..0 |  | Literal reference, Relative, internal or absolute URL
identifier |  | 1..1 | Identifier | Logical reference, when literal reference is not known
system |  | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/pseudo-bsn
source |  | 1..1 | Reference(Device) | Who and/or what defined the list contents (aka Author)
reference |  | 0..0 |  | Literal reference, Relative, internal or absolute URL
type |  | 0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Device
entry |  | 0..0 |  | Entries in the list
emptyReason |  | 1..1 | CodeableConcept | Why list is empty Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/list-empty-reason
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: withheld
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
List.code | Base | required | urn:oid:2.16.840.1.113883.2.4.3.111.3.3.11.2 | Not State | Unknown

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
Slices for identifier |  | 1..* | Identifier | Business identifier Slice: Unordered, Open by value:$this
identifier:AssignedId |  | 1..1 | Identifier | Business identifier
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text)
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 | 0..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 | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: author
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
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/ura
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
status | ?!Σ | 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. Required Pattern: working
title | Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients
code | Σ | 1..1 | CodeableConcept | What the purpose of this list is Binding: urn:oid:2.16.840.1.113883.2.4.3.111.3.3.11.2 (required)
subject | Σ | 1..1 | Reference(Patient) | If all resources have the same subject
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value: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 | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/pseudo-bsn
value | Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
encounter |  | 0..1 | Reference(Encounter) | Context in which list created
date | Σ | 0..1 | dateTime | When the list was prepared
source | Σ | 1..1 | Reference(Device) | Who and/or what defined the list contents (aka Author)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value: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). Required Pattern: Device
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
orderedBy |  | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list.
note |  | 0..* | Annotation | Comments about the list
emptyReason | C | 1..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/list-empty-reason
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: withheld
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
List.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​assigner.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​assigner.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.status | Base | required | ListStatus | 📍4.0.1 | FHIR Std.
List.mode | Base | required | ListMode | 📍4.0.1 | FHIR Std.
List.code | Base | required | urn:oid:2.16.840.1.113883.2.4.3.111.3.3.11.2 | Not State | Unknown
List.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.subject.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.subject.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.source.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.orderedBy | Base | preferred | List Order Codes | 📍4.0.1 | FHIR Std.
List.entry.flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std.
List.emptyReason | Base | preferred | List Empty Reasons | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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

Summary

Mandatory: 14 elements
Prohibited: 3 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of List.identifier

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
Slices for identifier |  | 1..* | Identifier | Business identifier Slice: Unordered, Open by value:$this
identifier:AssignedId |  | 1..1 | Identifier | Business identifier
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
assigner | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
coding | Σ | 1..1 | Coding | Code defined by a terminology system
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type
code | Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: author
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/ura
value | Σ | 1..1 | string | The value that is unique Example General: 123456
status | ?!Σ | 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. Required Pattern: working
code | Σ | 1..1 | CodeableConcept | What the purpose of this list is Binding: urn:oid:2.16.840.1.113883.2.4.3.111.3.3.11.2 (required)
subject | Σ | 1..1 | Reference(Patient) | If all resources have the same subject
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/pseudo-bsn
source | Σ | 1..1 | Reference(Device) | Who and/or what defined the list contents (aka Author)
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). Required Pattern: Device
emptyReason | C | 1..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/list-empty-reason
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: withheld
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
List.identifier:AssignedId.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​assigner.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​assigner.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.status | Base | required | ListStatus | 📍4.0.1 | FHIR Std.
List.mode | Base | required | ListMode | 📍4.0.1 | FHIR Std.
List.code | Base | required | urn:oid:2.16.840.1.113883.2.4.3.111.3.3.11.2 | Not State | Unknown
List.subject.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.source.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.emptyReason | Base | preferred | List Empty Reasons | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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
Slices for identifier |  | 1..* | Identifier | Business identifier Slice: Unordered, Open by value:$this
identifier:AssignedId |  | 1..1 | Identifier | Business identifier
system |  | 1..1 | uri | The namespace for the identifier value
value |  | 1..1 | string | The value that is unique
assigner |  | 1..1 | Reference(Organization) | Organization that issued id (may be just text)
identifier |  | 1..1 | Identifier | Logical reference, when literal reference is not known
type |  | 1..1 | CodeableConcept | Description of identifier
coding |  | 1..1 | Coding | Code defined by a terminology system
system |  | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type
code |  | 0..1 | code | Symbol in syntax defined by the system Required Pattern: author
system |  | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/ura
value |  | 1..1 | string | The value that is unique
status |  | 1..1 | code | current | retired | entered-in-error Required Pattern: current
mode |  | 1..1 | code | working | snapshot | changes Required Pattern: working
code |  | 1..1 | CodeableConcept | What the purpose of this list is Binding: urn:oid:2.16.840.1.113883.2.4.3.111.3.3.11.2 (required)
subject |  | 1..1 | Reference(Patient) | If all resources have the same subject
reference |  | 0..0 |  | Literal reference, Relative, internal or absolute URL
identifier |  | 1..1 | Identifier | Logical reference, when literal reference is not known
system |  | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/pseudo-bsn
source |  | 1..1 | Reference(Device) | Who and/or what defined the list contents (aka Author)
reference |  | 0..0 |  | Literal reference, Relative, internal or absolute URL
type |  | 0..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Device
entry |  | 0..0 |  | Entries in the list
emptyReason |  | 1..1 | CodeableConcept | Why list is empty Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/list-empty-reason
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: withheld
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
List.code | Base | required | urn:oid:2.16.840.1.113883.2.4.3.111.3.3.11.2 | Not State | Unknown

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
Slices for identifier |  | 1..* | Identifier | Business identifier Slice: Unordered, Open by value:$this
identifier:AssignedId |  | 1..1 | Identifier | Business identifier
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text)
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 | 0..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 | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/provenance-participant-type
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: author
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
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/ura
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
status | ?!Σ | 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. Required Pattern: working
title | Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients
code | Σ | 1..1 | CodeableConcept | What the purpose of this list is Binding: urn:oid:2.16.840.1.113883.2.4.3.111.3.3.11.2 (required)
subject | Σ | 1..1 | Reference(Patient) | If all resources have the same subject
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value: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 | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.nl/fhir/NamingSystem/pseudo-bsn
value | Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
encounter |  | 0..1 | Reference(Encounter) | Context in which list created
date | Σ | 0..1 | dateTime | When the list was prepared
source | Σ | 1..1 | Reference(Device) | Who and/or what defined the list contents (aka Author)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value: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). Required Pattern: Device
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
orderedBy |  | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list.
note |  | 0..* | Annotation | Comments about the list
emptyReason | C | 1..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/list-empty-reason
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: withheld
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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
List.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​assigner.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.identifier:AssignedId.​assigner.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.status | Base | required | ListStatus | 📍4.0.1 | FHIR Std.
List.mode | Base | required | ListMode | 📍4.0.1 | FHIR Std.
List.code | Base | required | urn:oid:2.16.840.1.113883.2.4.3.111.3.3.11.2 | Not State | Unknown
List.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.subject.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
List.subject.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
List.source.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
List.orderedBy | Base | preferred | List Order Codes | 📍4.0.1 | FHIR Std.
List.entry.flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std.
List.emptyReason | Base | preferred | List Empty Reasons | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
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

Summary

Mandatory: 14 elements
Prohibited: 3 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of List.identifier

Other representations of profile: CSV, Excel, Schematron