WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build International flag

WHO Digital Documentation of COVID-19 Certificates (DDCC), published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/ddcc/ and changes regularly. See the Directory of published versions

Resource Profile: DDCC Test

Official URL: http://smart.who.int/ddcc/StructureDefinition/DDCCTest Version: 1.0.0
Draft as of 2024-10-17 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:

Formal Views of Profile Content

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

This structure is derived from DeviceUvIps

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Device.typerequiredWHODDCCTypeofTestCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19
from this IG
Device.property:pathogen.valueCoderequiredWHODDCCAgentTargetedCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..* DeviceUvIps Item used in healthcare
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 0..1 code active | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status 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)
Additional BindingsPurpose
Medical Devices - SNOMED CT IPS Free Set candidate
Absent or Unknown Devices - IPS candidate
... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... property:pathogen 1..1 BackboneElement The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
..... 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
...... 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)
.... property:brand 0..1 BackboneElement The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
..... 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
...... 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)
... patient S 1..1 Reference(Patient (IPS)) Patient to whom Device is affixed
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|4.0.1
from the FHIR Standard
Device.typerequiredWHODDCCTypeofTestCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19
from this IG
Device.property:pathogen.valueCoderequiredWHODDCCAgentTargetedCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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)
Additional BindingsPurpose
Medical Devices - SNOMED CT IPS Free Set candidate
Absent or Unknown Devices - IPS candidate
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Device.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Device.udiCarrier.entryTyperequiredUDIEntryType
http://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1
from the FHIR Standard
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|4.0.1
from the FHIR Standard
Device.statusReasonextensibleFHIRDeviceStatusReason
http://hl7.org/fhir/ValueSet/device-status-reason
from the FHIR Standard
Device.deviceName.typerequiredDeviceNameType
http://hl7.org/fhir/ValueSet/device-nametype|4.0.1
from the FHIR Standard
Device.typerequiredWHODDCCTypeofTestCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19
from this IG
Device.property:pathogen.valueCoderequiredWHODDCCAgentTargetedCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19
from this IG
Device.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

  • The element 1 is sliced based on the value of Device.property

Differential View

This structure is derived from DeviceUvIps

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Device.typerequiredWHODDCCTypeofTestCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19
from this IG
Device.property:pathogen.valueCoderequiredWHODDCCAgentTargetedCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Device 0..* DeviceUvIps Item used in healthcare
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 0..1 code active | inactive | entered-in-error | unknown
Binding: FHIRDeviceStatus (required): The availability status 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)
Additional BindingsPurpose
Medical Devices - SNOMED CT IPS Free Set candidate
Absent or Unknown Devices - IPS candidate
... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
.... property:pathogen 1..1 BackboneElement The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
..... 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
...... 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)
.... property:brand 0..1 BackboneElement The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
..... 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
...... 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)
... patient S 1..1 Reference(Patient (IPS)) Patient to whom Device is affixed
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|4.0.1
from the FHIR Standard
Device.typerequiredWHODDCCTypeofTestCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19
from this IG
Device.property:pathogen.valueCoderequiredWHODDCCAgentTargetedCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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)
Additional BindingsPurpose
Medical Devices - SNOMED CT IPS Free Set candidate
Absent or Unknown Devices - IPS candidate
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Device.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Device.udiCarrier.entryTyperequiredUDIEntryType
http://hl7.org/fhir/ValueSet/udi-entry-type|4.0.1
from the FHIR Standard
Device.statusrequiredFHIRDeviceStatus
http://hl7.org/fhir/ValueSet/device-status|4.0.1
from the FHIR Standard
Device.statusReasonextensibleFHIRDeviceStatusReason
http://hl7.org/fhir/ValueSet/device-status-reason
from the FHIR Standard
Device.deviceName.typerequiredDeviceNameType
http://hl7.org/fhir/ValueSet/device-nametype|4.0.1
from the FHIR Standard
Device.typerequiredWHODDCCTypeofTestCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCTypeofTestCOVID19
from this IG
Device.property:pathogen.valueCoderequiredWHODDCCAgentTargetedCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCAgentTargetedCOVID19
from this IG
Device.patient.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDeviceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDeviceIf 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-4errorDeviceIf 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-5errorDeviceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDeviceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

  • The element 1 is sliced based on the value of Device.property

 

Other representations of profile: CSV, Excel, Schematron