WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.1 - release
WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.1 - release
This page is part of the WHO Digital Documentation of COVID-19 Certificates (DDCC) (v1.0.1: releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://smart.who.int/ddcc/StructureDefinition/DDCCTest | Version: 1.0.1 | |||
| Active as of 2024-12-18 | Computable Name: DDCCTest | |||
A DDCC Test contains the content corresponding to a row in the Test Events section of a Paper DDCC. While this is not a further profile of the International Patient Summary (IPS) Device resouce, this is intended to map into an IPS Device resource.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DeviceUvIps
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Device |
DeviceUvIps | |||
  manufacturer |
S | 1..1 | string | Name of device manufacturer |
| type |
1..1 | CodeableConceptIPS | Type of device.
Preferably valued by using SNOMED CT.
The absence of information, or of devices relevant for purpose of this IPS, shall be explicitly stated by using the codes included in the absent-or-unknown-devices-uv-ips value set. Binding: WHO Type of Covid-19 Test (required) | |
  Slices for property |
1..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties Slice: Unordered, Open by value:type | |
   property:pathogen |
1..1 | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |
  type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) 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://smart.who.int/ddcc/CodeSystem/DDCCDevicePropertyCodeSystem | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pathogen | |
 valueQuantity |
0..0 | |||
 valueCode |
1..1 | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) Binding: WHO Agent Targeted (COVID-19) (required) | |
 property:brand |
0..1 | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) 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://smart.who.int/ddcc/CodeSystem/DDCCDevicePropertyCodeSystem | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: brand | |
| valueQuantity |
0..0 | |||
| valueCode |
1..1 | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Device.type | required | WHODDCCTypeofTestCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19from this IG | |
| Device.property:pathogen.valueCode | required | WHODDCCAgentTargetedCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19from this IG |
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Device |
0..* | DeviceUvIps | Item used in healthcare 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 | |||||||
 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 | ||||||
 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 | ||||||
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. ele-1: All FHIR elements must have a @value or children | ||||||
| manufacturer |
S | 1..1 | string | Name of device manufacturer ele-1: All FHIR elements must have a @value or children | ||||||
 type |
S | 1..1 | CodeableConceptIPS | Type of device.
Preferably valued by using SNOMED CT.
The absence of information, or of devices relevant for purpose of this IPS, shall be explicitly stated by using the codes included in the absent-or-unknown-devices-uv-ips value set. Binding: WHO Type of Covid-19 Test (required)
ele-1: All FHIR elements must have a @value or children | ||||||
 Slices for property |
1..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children | |||||||
 property:All Slices |
Content/Rules for all slices | |||||||||
 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 | ||||||
 type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) ele-1: All FHIR elements must have a @value or children | |||||||
| property:pathogen |
1..1 | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties ele-1: All FHIR elements must have a @value or children | |||||||
| 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 | ||||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) ele-1: All FHIR elements must have a @value or children 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://smart.who.int/ddcc/CodeSystem/DDCCDevicePropertyCodeSystem | |||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pathogen | |||||||
| valueCode |
1..1 | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) Binding: WHO Agent Targeted (COVID-19) (required) ele-1: All FHIR elements must have a @value or children | |||||||
| property:brand |
0..1 | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties ele-1: All FHIR elements must have a @value or children | |||||||
| 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 | ||||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) ele-1: All FHIR elements must have a @value or children 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://smart.who.int/ddcc/CodeSystem/DDCCDevicePropertyCodeSystem | |||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: brand | |||||||
| valueCode |
1..1 | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) ele-1: All FHIR elements must have a @value or children | |||||||
 patient |
S | 1..1 | Reference(Patient (IPS)) | Patient to whom Device is affixed ele-1: All FHIR elements must have a @value or children | ||||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children | ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1from the FHIR Standard | |
| Device.type | required | WHODDCCTypeofTestCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19from this IG | |
| Device.property:pathogen.valueCode | required | WHODDCCAgentTargetedCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19from this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | 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 | Device | 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 | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Device |
0..* | DeviceUvIps | Item used in healthcare | |||||||
| 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.
| |||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
| 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 | Instance identifier | |||||||
| definition |
0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | |||||||
| udiCarrier |
Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||||
| 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 | ||||||
| deviceIdentifier |
Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||||
| issuer |
0..1 | uri | UDI Issuing Organization | |||||||
| jurisdiction |
0..1 | uri | Regional UDI authority | |||||||
| carrierAIDC |
Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||||
| carrierHRF |
Σ | 0..1 | string | UDI Human Readable Barcode String | ||||||
| entryType |
0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||||
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||||
| statusReason |
0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |||||||
| distinctIdentifier |
0..1 | string | The distinct identification string | |||||||
| manufacturer |
S | 1..1 | string | Name of device manufacturer | ||||||
| manufactureDate |
0..1 | dateTime | Date when the device was made | |||||||
| expirationDate |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |||||||
| lotNumber |
0..1 | string | Lot number of manufacture | |||||||
| serialNumber |
0..1 | string | Serial number assigned by the manufacturer | |||||||
| deviceName |
0..* | BackboneElement | The name of the device as given by the manufacturer | |||||||
| 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 | ||||||
| name |
1..1 | string | The name of the device | |||||||
| type |
1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. | |||||||
| modelNumber |
0..1 | string | The model number for the device | |||||||
| partNumber |
0..1 | string | The part number of the device | |||||||
| type |
S | 1..1 | CodeableConceptIPS | Type of device.
Preferably valued by using SNOMED CT.
The absence of information, or of devices relevant for purpose of this IPS, shall be explicitly stated by using the codes included in the absent-or-unknown-devices-uv-ips value set. Binding: WHO Type of Covid-19 Test (required)
| ||||||
| specialization |
0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |||||||
| 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 | ||||||
| systemType |
1..1 | CodeableConcept | The standard that is used to operate and communicate | |||||||
| version |
0..1 | string | The version of the standard that is used to operate and communicate | |||||||
| version |
0..* | BackboneElement | The actual design of the device or software version running on the device | |||||||
| 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 | ||||||
| type |
0..1 | CodeableConcept | The type of the device version | |||||||
| component |
0..1 | Identifier | A single component of the device version | |||||||
| value |
1..1 | string | The version text | |||||||
| Slices for property |
1..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties Slice: Unordered, Open by value:type | |||||||
| property:All Slices |
Content/Rules for all slices | |||||||||
| 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 | ||||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||||
| valueQuantity |
0..* | Quantity | Property value as a quantity | |||||||
| valueCode |
0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||||
| property:pathogen |
1..1 | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||||
| 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 | ||||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) 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://smart.who.int/ddcc/CodeSystem/DDCCDevicePropertyCodeSystem | |||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pathogen | |||||||
| 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 | |||||||
| valueCode |
1..1 | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) Binding: WHO Agent Targeted (COVID-19) (required) | |||||||
| property:brand |
0..1 | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||||
| 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 | ||||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) 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://smart.who.int/ddcc/CodeSystem/DDCCDevicePropertyCodeSystem | |||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: brand | |||||||
| 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 | |||||||
| valueCode |
1..1 | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||||
| patient |
S | 1..1 | Reference(Patient (IPS)) | Patient to whom Device is affixed | ||||||
| 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 | ||||||
| owner |
0..1 | Reference(Organization) | Organization responsible for device | |||||||
| contact |
0..* | ContactPoint | Details for human/organization for support | |||||||
| location |
0..1 | Reference(Location) | Where the device is found | |||||||
| url |
0..1 | uri | Network address to contact device | |||||||
| note |
0..* | Annotation | Device notes and comments | |||||||
| safety |
Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||||
| parent |
0..1 | Reference(Device) | The parent device | |||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI | |||
| Device.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Device.udiCarrier.entryType | required | UDIEntryTypehttp://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1from the FHIR Standard | ||||
| Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1from the FHIR Standard | ||||
| Device.statusReason | extensible | FHIRDeviceStatusReasonhttp://hl7.org/fhir/ValueSet/device-status-reasonfrom the FHIR Standard | ||||
| Device.deviceName.type | required | DeviceNameTypehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1from the FHIR Standard | ||||
| Device.type | required | WHODDCCTypeofTestCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19from this IG | ||||
| Device.property:pathogen.valueCode | required | WHODDCCAgentTargetedCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19from this IG | ||||
| Device.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | 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 | Device | 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 | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | 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() |
This structure is derived from DeviceUvIps
Summary
Mandatory: 5 elements(1 nested mandatory element)
Must-Support: 1 element
Prohibited: 2 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from DeviceUvIps
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Device |
DeviceUvIps | |||
| manufacturer |
S | 1..1 | string | Name of device manufacturer |
| type |
1..1 | CodeableConceptIPS | Type of device.
Preferably valued by using SNOMED CT.
The absence of information, or of devices relevant for purpose of this IPS, shall be explicitly stated by using the codes included in the absent-or-unknown-devices-uv-ips value set. Binding: WHO Type of Covid-19 Test (required) | |
| Slices for property |
1..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties Slice: Unordered, Open by value:type | |
| property:pathogen |
1..1 | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) 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://smart.who.int/ddcc/CodeSystem/DDCCDevicePropertyCodeSystem | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pathogen | |
| valueQuantity |
0..0 | |||
| valueCode |
1..1 | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) Binding: WHO Agent Targeted (COVID-19) (required) | |
| property:brand |
0..1 | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) 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://smart.who.int/ddcc/CodeSystem/DDCCDevicePropertyCodeSystem | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: brand | |
| valueQuantity |
0..0 | |||
| valueCode |
1..1 | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Device.type | required | WHODDCCTypeofTestCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19from this IG | |
| Device.property:pathogen.valueCode | required | WHODDCCAgentTargetedCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19from this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Device |
0..* | DeviceUvIps | Item used in healthcare 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 | |||||||
| 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 | ||||||
| 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 | ||||||
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. ele-1: All FHIR elements must have a @value or children | ||||||
| manufacturer |
S | 1..1 | string | Name of device manufacturer ele-1: All FHIR elements must have a @value or children | ||||||
| type |
S | 1..1 | CodeableConceptIPS | Type of device.
Preferably valued by using SNOMED CT.
The absence of information, or of devices relevant for purpose of this IPS, shall be explicitly stated by using the codes included in the absent-or-unknown-devices-uv-ips value set. Binding: WHO Type of Covid-19 Test (required)
ele-1: All FHIR elements must have a @value or children | ||||||
| Slices for property |
1..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children | |||||||
| property:All Slices |
Content/Rules for all slices | |||||||||
| 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 | ||||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) ele-1: All FHIR elements must have a @value or children | |||||||
| property:pathogen |
1..1 | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties ele-1: All FHIR elements must have a @value or children | |||||||
| 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 | ||||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) ele-1: All FHIR elements must have a @value or children 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://smart.who.int/ddcc/CodeSystem/DDCCDevicePropertyCodeSystem | |||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pathogen | |||||||
| valueCode |
1..1 | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) Binding: WHO Agent Targeted (COVID-19) (required) ele-1: All FHIR elements must have a @value or children | |||||||
| property:brand |
0..1 | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties ele-1: All FHIR elements must have a @value or children | |||||||
| 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 | ||||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) ele-1: All FHIR elements must have a @value or children 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://smart.who.int/ddcc/CodeSystem/DDCCDevicePropertyCodeSystem | |||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: brand | |||||||
| valueCode |
1..1 | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) ele-1: All FHIR elements must have a @value or children | |||||||
| patient |
S | 1..1 | Reference(Patient (IPS)) | Patient to whom Device is affixed ele-1: All FHIR elements must have a @value or children | ||||||
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children | ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1from the FHIR Standard | |
| Device.type | required | WHODDCCTypeofTestCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19from this IG | |
| Device.property:pathogen.valueCode | required | WHODDCCAgentTargetedCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19from this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | 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 | Device | 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 | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Device |
0..* | DeviceUvIps | Item used in healthcare | |||||||
| 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.
| |||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
| 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 | Instance identifier | |||||||
| definition |
0..1 | Reference(DeviceDefinition) | The reference to the definition for the device | |||||||
| udiCarrier |
Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string | ||||||
| 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 | ||||||
| deviceIdentifier |
Σ | 0..1 | string | Mandatory fixed portion of UDI | ||||||
| issuer |
0..1 | uri | UDI Issuing Organization | |||||||
| jurisdiction |
0..1 | uri | Regional UDI authority | |||||||
| carrierAIDC |
Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String | ||||||
| carrierHRF |
Σ | 0..1 | string | UDI Human Readable Barcode String | ||||||
| entryType |
0..1 | code | barcode | rfid | manual + Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |||||||
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error | unknown Binding: FHIRDeviceStatus (required): The availability status of the device. | ||||||
| statusReason |
0..* | CodeableConcept | online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off Binding: FHIRDeviceStatusReason (extensible): The availability status reason of the device. | |||||||
| distinctIdentifier |
0..1 | string | The distinct identification string | |||||||
| manufacturer |
S | 1..1 | string | Name of device manufacturer | ||||||
| manufactureDate |
0..1 | dateTime | Date when the device was made | |||||||
| expirationDate |
0..1 | dateTime | Date and time of expiry of this device (if applicable) | |||||||
| lotNumber |
0..1 | string | Lot number of manufacture | |||||||
| serialNumber |
0..1 | string | Serial number assigned by the manufacturer | |||||||
| deviceName |
0..* | BackboneElement | The name of the device as given by the manufacturer | |||||||
| 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 | ||||||
| name |
1..1 | string | The name of the device | |||||||
| type |
1..1 | code | udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other Binding: DeviceNameType (required): The type of name the device is referred by. | |||||||
| modelNumber |
0..1 | string | The model number for the device | |||||||
| partNumber |
0..1 | string | The part number of the device | |||||||
| type |
S | 1..1 | CodeableConceptIPS | Type of device.
Preferably valued by using SNOMED CT.
The absence of information, or of devices relevant for purpose of this IPS, shall be explicitly stated by using the codes included in the absent-or-unknown-devices-uv-ips value set. Binding: WHO Type of Covid-19 Test (required)
| ||||||
| specialization |
0..* | BackboneElement | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication | |||||||
| 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 | ||||||
| systemType |
1..1 | CodeableConcept | The standard that is used to operate and communicate | |||||||
| version |
0..1 | string | The version of the standard that is used to operate and communicate | |||||||
| version |
0..* | BackboneElement | The actual design of the device or software version running on the device | |||||||
| 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 | ||||||
| type |
0..1 | CodeableConcept | The type of the device version | |||||||
| component |
0..1 | Identifier | A single component of the device version | |||||||
| value |
1..1 | string | The version text | |||||||
| Slices for property |
1..* | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties Slice: Unordered, Open by value:type | |||||||
| property:All Slices |
Content/Rules for all slices | |||||||||
| 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 | ||||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) | |||||||
| valueQuantity |
0..* | Quantity | Property value as a quantity | |||||||
| valueCode |
0..* | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||||
| property:pathogen |
1..1 | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||||
| 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 | ||||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) 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://smart.who.int/ddcc/CodeSystem/DDCCDevicePropertyCodeSystem | |||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pathogen | |||||||
| 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 | |||||||
| valueCode |
1..1 | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) Binding: WHO Agent Targeted (COVID-19) (required) | |||||||
| property:brand |
0..1 | BackboneElement | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties | |||||||
| 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 | ||||||
| type |
1..1 | CodeableConcept | Code that specifies the property DeviceDefinitionPropetyCode (Extensible) 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://smart.who.int/ddcc/CodeSystem/DDCCDevicePropertyCodeSystem | |||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: brand | |||||||
| 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 | |||||||
| valueCode |
1..1 | CodeableConcept | Property value as a code, e.g., NTP4 (synced to NTP) | |||||||
| patient |
S | 1..1 | Reference(Patient (IPS)) | Patient to whom Device is affixed | ||||||
| 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 | ||||||
| owner |
0..1 | Reference(Organization) | Organization responsible for device | |||||||
| contact |
0..* | ContactPoint | Details for human/organization for support | |||||||
| location |
0..1 | Reference(Location) | Where the device is found | |||||||
| url |
0..1 | uri | Network address to contact device | |||||||
| note |
0..* | Annotation | Device notes and comments | |||||||
| safety |
Σ | 0..* | CodeableConcept | Safety Characteristics of Device | ||||||
| parent |
0..1 | Reference(Device) | The parent device | |||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI | |||
| Device.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Device.udiCarrier.entryType | required | UDIEntryTypehttp://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1from the FHIR Standard | ||||
| Device.status | required | FHIRDeviceStatushttp://hl7.org/fhir/ValueSet/device-status|4.0.1from the FHIR Standard | ||||
| Device.statusReason | extensible | FHIRDeviceStatusReasonhttp://hl7.org/fhir/ValueSet/device-status-reasonfrom the FHIR Standard | ||||
| Device.deviceName.type | required | DeviceNameTypehttp://hl7.org/fhir/ValueSet/device-nametype|4.0.1from the FHIR Standard | ||||
| Device.type | required | WHODDCCTypeofTestCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19from this IG | ||||
| Device.property:pathogen.valueCode | required | WHODDCCAgentTargetedCOVID19http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19from this IG | ||||
| Device.patient.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | 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 | Device | 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 | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | 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() |
This structure is derived from DeviceUvIps
Summary
Mandatory: 5 elements(1 nested mandatory element)
Must-Support: 1 element
Prohibited: 2 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron