Taiwan Digital COVID Certificate
0.0.1 - CI Build

Taiwan Digital COVID Certificate - Local Development build (v0.0.1). See the Directory of published versions

Resource Profile: ImmunizationRecommendation ( Taiwan Digital COVID Certificate )

Defining URL:https://ghit42796.github.io/fhir_test/StructureDefinition-ImmunizationRecommendation-TDCC
Version:0.0.1
Name:ImmunizationRecommendationTDCC
Title:ImmunizationRecommendation ( Taiwan Digital COVID Certificate )
Status:Draft as of 2021-06-22
Definition:

Immunization Recommandations Profile for Vaccine Certificate

Publisher:TBD
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://ghit42796.github.io/fhir_test/StructureDefinition-ImmunizationRecommendation-TDCC

Formal Views of Profile Content

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

This structure is derived from ImmunizationRecommendation

Summary

Mandatory: 1 element
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element ImmunizationRecommendation.recommendation.dateCriterion is sliced based on the value of pattern:code

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... patient S1..1Reference(Patient ( Taiwan Digital COVID Certificate ))Who this profile is for
... date S1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(Organization ( Taiwan Digital COVID Certificate ))Who is responsible for protocol
.... vaccineCode 0..*CodeableConceptGeneric description of the vaccine/prophylaxis or its component(s)
.... targetDisease 0..1CodeableConceptDisease or agent that the vaccination provides protection against
.... forecastStatus S1..1CodeableConceptVaccine recommendation status
.... dateCriterion 0..*(Slice Definition)Dates governing proposed immunization
Slice: Unordered, Open by pattern:code
..... dateCriterion:nextDose 0..1BackboneElementDates governing proposed immunization
...... code 1..1CodeableConceptType of date
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 30980-7
.... supportingImmunization S1..*Reference(Immunization ( Taiwan Digital COVID Certificate ))Past immunizations supporting recommendation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... patient SΣ1..1Reference(Patient ( Taiwan Digital COVID Certificate ))Who this profile is for
... date SΣ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(Organization ( Taiwan Digital COVID Certificate ))Who is responsible for protocol
... recommendation ΣI1..*BackboneElementVaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... 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
.... vaccineCode Σ0..*CodeableConceptGeneric description of the vaccine/prophylaxis or its component(s)
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... targetDisease Σ0..1CodeableConceptDisease or agent that the vaccination provides protection against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.

.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... forecastStatus ?!SΣ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... forecastReason Σ0..*CodeableConceptVaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.


.... dateCriterion 0..*(Slice Definition)Dates governing proposed immunization
Slice: Unordered, Open by pattern:code
..... dateCriterion: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
...... code 1..1CodeableConceptType of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).

...... value 1..1dateTimeRecommended date
..... dateCriterion:nextDose 0..1BackboneElementDates governing proposed immunization
...... 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
...... code 1..1CodeableConceptType of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 30980-7
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... value 1..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization S1..*Reference(Immunization ( Taiwan Digital COVID Certificate ))Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(Resource)Patient observations supporting recommendation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... patient Σ1..1Reference(Patient ( Taiwan Digital COVID Certificate ))Who this profile is for
... date Σ1..1dateTimeDate recommendation(s) created
... recommendation ΣI1..*BackboneElementVaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... supportingImmunization 1..*Reference(Immunization ( Taiwan Digital COVID Certificate ))Past immunizations supporting recommendation

doco Documentation for this format

This structure is derived from ImmunizationRecommendation

Summary

Mandatory: 1 element
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element ImmunizationRecommendation.recommendation.dateCriterion is sliced based on the value of pattern:code

Differential View

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... patient S1..1Reference(Patient ( Taiwan Digital COVID Certificate ))Who this profile is for
... date S1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(Organization ( Taiwan Digital COVID Certificate ))Who is responsible for protocol
.... vaccineCode 0..*CodeableConceptGeneric description of the vaccine/prophylaxis or its component(s)
.... targetDisease 0..1CodeableConceptDisease or agent that the vaccination provides protection against
.... forecastStatus S1..1CodeableConceptVaccine recommendation status
.... dateCriterion 0..*(Slice Definition)Dates governing proposed immunization
Slice: Unordered, Open by pattern:code
..... dateCriterion:nextDose 0..1BackboneElementDates governing proposed immunization
...... code 1..1CodeableConceptType of date
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 30980-7
.... supportingImmunization S1..*Reference(Immunization ( Taiwan Digital COVID Certificate ))Past immunizations supporting recommendation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... patient SΣ1..1Reference(Patient ( Taiwan Digital COVID Certificate ))Who this profile is for
... date SΣ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(Organization ( Taiwan Digital COVID Certificate ))Who is responsible for protocol
... recommendation ΣI1..*BackboneElementVaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... 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
.... vaccineCode Σ0..*CodeableConceptGeneric description of the vaccine/prophylaxis or its component(s)
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... targetDisease Σ0..1CodeableConceptDisease or agent that the vaccination provides protection against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.

.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... forecastStatus ?!SΣ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... forecastReason Σ0..*CodeableConceptVaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.


.... dateCriterion 0..*(Slice Definition)Dates governing proposed immunization
Slice: Unordered, Open by pattern:code
..... dateCriterion: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
...... code 1..1CodeableConceptType of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).

...... value 1..1dateTimeRecommended date
..... dateCriterion:nextDose 0..1BackboneElementDates governing proposed immunization
...... 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
...... code 1..1CodeableConceptType of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: 30980-7
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... value 1..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization S1..*Reference(Immunization ( Taiwan Digital COVID Certificate ))Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(Resource)Patient observations supporting recommendation

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
ImmunizationRecommendation.languagepreferredCommonLanguages
Max Binding: AllLanguages
ImmunizationRecommendation.recommendation.vaccineCodeexampleVaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.targetDiseaseexampleImmunizationRecommendationTargetDiseaseCodes
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes
ImmunizationRecommendation.recommendation.dateCriterion:nextDose.codeexamplePattern: LOINC code 30980-7

Constraints

IdPathDetailsRequirements
dom-2ImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ImmunizationRecommendationIf 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-4ImmunizationRecommendationIf 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-5ImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ImmunizationRecommendationA resource should have narrative for robust management
: text.`div`.exists()
ele-1ImmunizationRecommendation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.authorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
imr-1ImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()
ele-1ImmunizationRecommendation.recommendation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.vaccineCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.targetDiseaseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.forecastStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.forecastReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.dateCriterionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.dateCriterion.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.dateCriterion.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.dateCriterion.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.dateCriterion.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.dateCriterion.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.dateCriterion.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.dateCriterion:nextDoseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.dateCriterion:nextDose.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.dateCriterion:nextDose.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.dateCriterion:nextDose.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.dateCriterion:nextDose.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.dateCriterion:nextDose.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.dateCriterion:nextDose.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.seriesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.doseNumber[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.seriesDoses[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.supportingImmunizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.supportingPatientInformationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())