WHO Digital Documentation of COVID-19 Certificates: Vaccination Status (DDCC:VS)
0.2.1 - CI Build

WHO Digital Documentation of COVID-19 Certificates: Vaccination Status (DDCC:VS) - Local Development build (v0.2.1). See the Directory of published versions

Resource Profile: DDCC Generate Health Certificate Parameters

Defining URL:http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCGenerateHealthCertificateParameters
Version:0.2.1
Name:DDCCGenerateHealthCertificateParameters
Title:DDCC Generate Health Certificate Parameters
Status:Active as of 11/22/21, 5:53 PM
Definition:

Parameters for the DDCC Generate Health Certificate Operation.

Publisher:WHO
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

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

Formal Views of Profile Content

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

This structure is derived from Parameters

Summary

Mandatory: 1 element (3 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:name (Closed)
  • The element Parameters.parameter.value[x] is sliced based on the value of type:$this

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter 1..*BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:ddccResponse 0..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Required Pattern: response
..... resource 1..1DDCCQuestionnaireResponseSDC Questionnaire Response
.... parameter:ddccId 0..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Required Pattern: id
..... Slices for value[x] 1..1idIf parameter is a data type
Slice: Unordered, Open by type:$this
..... valueId 1..1idIf parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣI1..*BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:All Slices Content/Rules for all slices
..... 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
..... name Σ1..1stringName from the definition
..... value[x] ΣI0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:ddccResponse ΣI0..1BackboneElementOperation Parameter
..... 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
..... name Σ1..1stringName from the definition
Required Pattern: response
..... value[x] ΣI0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource I1..1DDCCQuestionnaireResponseSDC Questionnaire Response
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:ddccId ΣI0..1BackboneElementOperation Parameter
..... 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
..... name Σ1..1stringName from the definition
Required Pattern: id
..... Slices for value[x] ΣI1..1idIf parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueId ΣI1..1idIf parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format

This structure is derived from Parameters

Summary

Mandatory: 1 element (3 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:name (Closed)
  • The element Parameters.parameter.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter 1..*BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:ddccResponse 0..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Required Pattern: response
..... resource 1..1DDCCQuestionnaireResponseSDC Questionnaire Response
.... parameter:ddccId 0..1BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Required Pattern: id
..... Slices for value[x] 1..1idIf parameter is a data type
Slice: Unordered, Open by type:$this
..... valueId 1..1idIf parameter is a data type

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣI1..*BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:All Slices Content/Rules for all slices
..... 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
..... name Σ1..1stringName from the definition
..... value[x] ΣI0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:ddccResponse ΣI0..1BackboneElementOperation Parameter
..... 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
..... name Σ1..1stringName from the definition
Required Pattern: response
..... value[x] ΣI0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource I1..1DDCCQuestionnaireResponseSDC Questionnaire Response
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:ddccId ΣI0..1BackboneElementOperation Parameter
..... 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
..... name Σ1..1stringName from the definition
Required Pattern: id
..... Slices for value[x] ΣI1..1idIf parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueId ΣI1..1idIf parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Max Binding: AllLanguages

Constraints

IdPathDetailsRequirements
ele-1Parameters.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1Parameters.parameterA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
ele-1Parameters.parameter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter.partAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:ddccResponseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1Parameters.parameter:ddccResponseA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
ele-1Parameters.parameter:ddccResponse.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:ddccResponse.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:ddccResponse.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:ddccResponse.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:ddccResponse.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:ddccResponse.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
dom-2Parameters.parameter:ddccResponse.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3Parameters.parameter:ddccResponse.resourceIf 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-4Parameters.parameter:ddccResponse.resourceIf 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-5Parameters.parameter:ddccResponse.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Parameters.parameter:ddccResponse.resourceA resource should have narrative for robust management
: text.`div`.exists()
sdcqr-1Parameters.parameter:ddccResponse.resourceSubject SHOULD be present (searching is difficult without subject). Almost all QuestionnaireResponses should be with respect to some sort of subject.
: subject.exists()
sdcqr-2Parameters.parameter:ddccResponse.resourceWhen repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers.
: (QuestionnaireResponse|repeat(answer|item)).select(item.where(answer.value.exists()).linkId.isDistinct()).allTrue()
ele-1Parameters.parameter:ddccResponse.partAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:ddccIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1Parameters.parameter:ddccIdA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
ele-1Parameters.parameter:ddccId.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:ddccId.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:ddccId.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:ddccId.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:ddccId.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:ddccId.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:ddccId.value[x]:valueIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:ddccId.partAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())