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.

Resource Profile: DDCC Procedure

Defining URL:http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCProcedure
Version:1.0.0
Name:DDCCProcedure
Title:DDCC Procedure
Status:Active as of 2022-11-23 03:17:18+0000
Definition:

A DDCC Procedure 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) Procedure resouce, this is intended to map into an IPS Procedure resource.

Publisher:WHO
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCProcedure

Formal Views of Profile Content

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

This structure is derived from ProcedureUvIps

Summary

Mandatory: 4 elements
Must-Support: 4 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from ProcedureUvIps

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*ProcedureUvIpsAn action that is being or was performed on a patient
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... country S1..1codeDDCC Country Of Event for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCCountryOfEvent
Binding: Iso3166-1-3 (preferred)
... status 1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Fixed Value: completed
... location S0..1Reference(Location)Where the procedure happened
... report S1..1Reference(DDCC Diagnostic Report)Any report resulting from the procedure
... usedReference S1..1Reference(DDCC Test)Items used during procedure

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure S0..*ProcedureUvIpsAn action that is being or was performed on a patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... country S1..1codeDDCC Country Of Event for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCCountryOfEvent
Binding: Iso3166-1-3 (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifiers for this procedure
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)A request for this procedure
... partOf Σ0..*Reference(Procedure | Observation | MedicationAdministration)Part of referenced event
... status ?!SΣ1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.


Fixed Value: completed
... statusReason Σ0..1CodeableConceptReason for current status
Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.

... category Σ0..1CodeableConceptClassification of the procedure
Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes.

... Slices for code SΣ1..1CodeableConceptIPSConcept - reference to a terminology or just text
Slice: Unordered, Open by pattern:$this
Binding: Procedures - IPS (preferred)
.... code:absentOrUnknownProcedure S0..1CodeableConceptIPSCode for absent problem or for unknown procedure
Binding: Absent or Unknown Procedures - IPS (required): A code to identify absent or unknown procedures

... subject SΣ1..1Reference(Patient (IPS))Who the procedure was performed on
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... performed[x] SΣ1..1dateTimeWhen the procedure was performed
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... data-absent-reason S0..1codeperformed[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


... recorder Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Who recorded the procedure
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Person who asserts this procedure
... performer Σ0..*BackboneElementThe people who performed the procedure
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptType of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.

.... actor Σ1..1Reference(Patient (IPS) | RelatedPerson | Device (performer, observer) | Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS))The reference to the practitioner
.... onBehalfOf 0..1Reference(Organization (IPS))Organization the device or practitioner was acting for
... location SΣ0..1Reference(Location)Where the procedure happened
... reasonCode Σ0..*CodeableConceptCoded reason procedure performed
Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.


... reasonReference Σ0..*Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference)The justification that the procedure was performed
... bodySite S0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (example)
... outcome Σ0..1CodeableConceptThe result of procedure
Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.

... report S1..1Reference(DDCC Diagnostic Report)Any report resulting from the procedure
... complication 0..*CodeableConceptComplication following the procedure
Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.


... complicationDetail 0..*Reference(Condition)A condition that is a result of the procedure
... followUp 0..*CodeableConceptInstructions for follow up
Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures.


... note 0..*AnnotationAdditional information about the procedure
... focalDevice 0..*BackboneElementManipulated, implanted, or removed device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... action 0..1CodeableConceptKind of change to device
Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure.

.... manipulated 1..1Reference(Device)Device that was changed
... usedReference S1..1Reference(DDCC Test)Items used during procedure
... usedCode 0..*CodeableConceptCoded items used during the procedure
Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure.



doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*ProcedureUvIpsAn action that is being or was performed on a patient
... country 1..1codeDDCC Country Of Event for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCCountryOfEvent
Binding: Iso3166-1-3 (preferred)
... status ?!Σ1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.


Fixed Value: completed
... Slices for code Σ1..1CodeableConceptIPSConcept - reference to a terminology or just text
Slice: Unordered, Open by pattern:$this
Binding: Procedures - IPS (preferred)
.... code:absentOrUnknownProcedure 0..1CodeableConceptIPSCode for absent problem or for unknown procedure
Binding: Absent or Unknown Procedures - IPS (required): A code to identify absent or unknown procedures

.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... performed[x] Σ1..1dateTimeWhen the procedure was performed
.... data-absent-reason 0..1codeperformed[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


... location Σ0..1Reference(Location)Where the procedure happened
... bodySite 0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (example)
... report 1..1Reference(DDCC Diagnostic Report)Any report resulting from the procedure
... usedReference 1..1Reference(DDCC Test)Items used during procedure

doco Documentation for this format

This structure is derived from ProcedureUvIps

Summary

Mandatory: 4 elements
Must-Support: 4 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from ProcedureUvIps

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure 0..*ProcedureUvIpsAn action that is being or was performed on a patient
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... country S1..1codeDDCC Country Of Event for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCCountryOfEvent
Binding: Iso3166-1-3 (preferred)
... status 1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Fixed Value: completed
... location S0..1Reference(Location)Where the procedure happened
... report S1..1Reference(DDCC Diagnostic Report)Any report resulting from the procedure
... usedReference S1..1Reference(DDCC Test)Items used during procedure

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure S0..*ProcedureUvIpsAn action that is being or was performed on a patient
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... country S1..1codeDDCC Country Of Event for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCCountryOfEvent
Binding: Iso3166-1-3 (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifiers for this procedure
... instantiatesCanonical Σ0..*canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | ServiceRequest)A request for this procedure
... partOf Σ0..*Reference(Procedure | Observation | MedicationAdministration)Part of referenced event
... status ?!SΣ1..1codepreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Binding: EventStatus (required): A code specifying the state of the procedure.


Fixed Value: completed
... statusReason Σ0..1CodeableConceptReason for current status
Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed.

... category Σ0..1CodeableConceptClassification of the procedure
Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes.

... Slices for code SΣ1..1CodeableConceptIPSConcept - reference to a terminology or just text
Slice: Unordered, Open by pattern:$this
Binding: Procedures - IPS (preferred)
.... code:absentOrUnknownProcedure S0..1CodeableConceptIPSCode for absent problem or for unknown procedure
Binding: Absent or Unknown Procedures - IPS (required): A code to identify absent or unknown procedures

... subject SΣ1..1Reference(Patient (IPS))Who the procedure was performed on
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... performed[x] SΣ1..1dateTimeWhen the procedure was performed
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... data-absent-reason S0..1codeperformed[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


... recorder Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Who recorded the procedure
... asserter Σ0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)Person who asserts this procedure
... performer Σ0..*BackboneElementThe people who performed the procedure
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptType of performance
Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure.

.... actor Σ1..1Reference(Patient (IPS) | RelatedPerson | Device (performer, observer) | Practitioner (IPS) | PractitionerRole (IPS) | Organization (IPS))The reference to the practitioner
.... onBehalfOf 0..1Reference(Organization (IPS))Organization the device or practitioner was acting for
... location SΣ0..1Reference(Location)Where the procedure happened
... reasonCode Σ0..*CodeableConceptCoded reason procedure performed
Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.


... reasonReference Σ0..*Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference)The justification that the procedure was performed
... bodySite S0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (example)
... outcome Σ0..1CodeableConceptThe result of procedure
Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise.

... report S1..1Reference(DDCC Diagnostic Report)Any report resulting from the procedure
... complication 0..*CodeableConceptComplication following the procedure
Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure.


... complicationDetail 0..*Reference(Condition)A condition that is a result of the procedure
... followUp 0..*CodeableConceptInstructions for follow up
Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures.


... note 0..*AnnotationAdditional information about the procedure
... focalDevice 0..*BackboneElementManipulated, implanted, or removed device
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... action 0..1CodeableConceptKind of change to device
Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure.

.... manipulated 1..1Reference(Device)Device that was changed
... usedReference S1..1Reference(DDCC Test)Items used during procedure
... usedCode 0..*CodeableConceptCoded items used during the procedure
Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure.



doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Procedure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Procedure.statusrequiredFixed Value: completed
Procedure.statusReasonexampleProcedureNotPerformedReason(SNOMED-CT)
Procedure.categoryexampleProcedureCategoryCodes(SNOMEDCT)
Procedure.codepreferredProceduresUvIps
Procedure.code:absentOrUnknownProcedurerequiredNoProceduresInfoUvIps
Procedure.subject.typeextensibleResourceType
Procedure.performer.functionexampleProcedurePerformerRoleCodes
Procedure.reasonCodeexampleProcedureReasonCodes
Procedure.bodySiteexampleSNOMEDCTBodyStructures
Procedure.outcomeexampleProcedureOutcomeCodes(SNOMEDCT)
Procedure.complicationexampleCondition/Problem/DiagnosisCodes
Procedure.followUpexampleProcedureFollowUpCodes(SNOMEDCT)
Procedure.focalDevice.actionpreferredProcedureDeviceActionCodes
Procedure.usedCodeexampleFHIRDeviceTypes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProcedureIf 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-4errorProcedureIf 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-5errorProcedureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProcedureA 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()