WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build
This is the continuous build for version 1.0.0. This version is based on the current content of https://github.com/WorldHealthOrganization/ddcc and changes regularly.
Official URL: http://smart.who.int/ddcc/StructureDefinition/DDCCFolder | Version: 1.0.0 | |||
Draft as of 2024-01-19 | Computable Name: DDCCFolder |
DDCC Folder of the Paper Certificate
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Folder
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | 0..* | Folder | A list is a curated collection of resources | |
extension | 1..* | Extension | Extension | |
Slices for extension:designationType | 1..* | DesignationType | Clinical code of the List Slice: Unordered, Open by value:valueCodeableConcept.coding.system, value:valueCodeableConcept.coding.code | |
extension:designationType/ddccDesignation | 1..1 | Extension | Extension | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
coding | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCC-Folder-DesignationType | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ddcc | |
subject | 1..1 | Reference(DDCC Patient) | If all resources have the same subject | |
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
entry | ||||
item | 1..1 | Reference(DDCC Document Reference) | Actual entry | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | C | 0..* | Folder | A list is a curated collection of resources |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
designationType | S | 1..* | CodeableConcept | Clinical code of the List URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType |
extension:designationType/ddccDesignation | 1..1 | Extension | Extension | |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCC-Folder-DesignationType | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ddcc | |
Slices for identifier | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:use | |
identifier:uniqueId | 0..1 | UniqueIdIdentifier | An identifier intended for computation | |
identifier:entryUUID | 0..* | EntryUUIDIdentifier | An identifier intended for computation | |
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. Required Pattern: working |
code | Σ | 1..1 | CodeableConcept | What the purpose of this list is Binding: MHD List Types ValueSet (required) 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: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: folder | |
subject | SΣ | 1..1 | Reference(DDCC Patient) | If all resources have the same subject |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
note | 0..1 | Annotation | Comments about the list | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
List.status | required | ListStatus |
List.mode | required | Pattern: working |
List.code | required | Pattern: folder |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
List | C | 0..* | Folder | A list is a curated collection of resources | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
designationType | S | 1..* | CodeableConcept | Clinical code of the List URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType | ||||
extension:designationType/ddccDesignation | 1..1 | Extension | Extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | identifies the meaning of the extension | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |||||
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 Required Pattern: At least the following | ||||
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://smart.who.int/ddcc/CodeSystem/DDCC-Folder-DesignationType | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ddcc | |||||
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 | ||||
Slices for identifier | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:use | |||||
identifier:uniqueId | 0..1 | UniqueIdIdentifier | An identifier intended for computation | |||||
identifier:entryUUID | 0..* | EntryUUIDIdentifier | An identifier intended for computation | |||||
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. 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: MHD List Types ValueSet (required) 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: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: folder | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
subject | SΣ | 1..1 | Reference(DDCC 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 | |||||
reference | SΣ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 | ||||
date | Σ | 0..1 | dateTime | When the list was prepared | ||||
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 | ||||
item | 1..1 | Reference(DDCC Document Reference) | Actual entry | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
List.meta.security | extensible | All Security Labels | ||||
List.meta.tag | example | CommonTags | ||||
List.language | preferred | CommonLanguages
| ||||
List.status | required | ListStatus | ||||
List.mode | required | Pattern: working | ||||
List.code | required | Pattern: folder | ||||
List.subject.type | extensible | ResourceType |
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 Folder
Differential View
This structure is derived from Folder
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | 0..* | Folder | A list is a curated collection of resources | |
extension | 1..* | Extension | Extension | |
Slices for extension:designationType | 1..* | DesignationType | Clinical code of the List Slice: Unordered, Open by value:valueCodeableConcept.coding.system, value:valueCodeableConcept.coding.code | |
extension:designationType/ddccDesignation | 1..1 | Extension | Extension | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
coding | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCC-Folder-DesignationType | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ddcc | |
subject | 1..1 | Reference(DDCC Patient) | If all resources have the same subject | |
reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
entry | ||||
item | 1..1 | Reference(DDCC Document Reference) | Actual entry | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | C | 0..* | Folder | A list is a curated collection of resources |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
designationType | S | 1..* | CodeableConcept | Clinical code of the List URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType |
extension:designationType/ddccDesignation | 1..1 | Extension | Extension | |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCC-Folder-DesignationType | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ddcc | |
Slices for identifier | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:use | |
identifier:uniqueId | 0..1 | UniqueIdIdentifier | An identifier intended for computation | |
identifier:entryUUID | 0..* | EntryUUIDIdentifier | An identifier intended for computation | |
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. Required Pattern: working |
code | Σ | 1..1 | CodeableConcept | What the purpose of this list is Binding: MHD List Types ValueSet (required) 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: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: folder | |
subject | SΣ | 1..1 | Reference(DDCC Patient) | If all resources have the same subject |
reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
note | 0..1 | Annotation | Comments about the list | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
List.status | required | ListStatus |
List.mode | required | Pattern: working |
List.code | required | Pattern: folder |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
List | C | 0..* | Folder | A list is a curated collection of resources | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
designationType | S | 1..* | CodeableConcept | Clinical code of the List URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-designationType | ||||
extension:designationType/ddccDesignation | 1..1 | Extension | Extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | identifies the meaning of the extension | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |||||
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 Required Pattern: At least the following | ||||
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://smart.who.int/ddcc/CodeSystem/DDCC-Folder-DesignationType | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ddcc | |||||
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 | ||||
Slices for identifier | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:use | |||||
identifier:uniqueId | 0..1 | UniqueIdIdentifier | An identifier intended for computation | |||||
identifier:entryUUID | 0..* | EntryUUIDIdentifier | An identifier intended for computation | |||||
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. 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: MHD List Types ValueSet (required) 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: https://profiles.ihe.net/ITI/MHD/CodeSystem/MHDlistTypes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: folder | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
subject | SΣ | 1..1 | Reference(DDCC 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 | |||||
reference | SΣ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 | ||||
date | Σ | 0..1 | dateTime | When the list was prepared | ||||
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 | ||||
item | 1..1 | Reference(DDCC Document Reference) | Actual entry | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
List.meta.security | extensible | All Security Labels | ||||
List.meta.tag | example | CommonTags | ||||
List.language | preferred | CommonLanguages
| ||||
List.status | required | ListStatus | ||||
List.mode | required | Pattern: working | ||||
List.code | required | Pattern: folder | ||||
List.subject.type | extensible | ResourceType |
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 Folder
Other representations of profile: CSV, Excel, Schematron