0.1.0 - ci-build

covid19immunizationig - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: Covid19 Immunization

Defining URL:https://jembi.github.io/covid19-immunization-ig//StructureDefinition/covid19-immunization
Version:0.1.0
Name:Covid19Immunization
Title:Covid19 Immunization
Status:Active as of 2021-02-04T07:17:56+00:00
Definition:

Defines an immunization profile for the COVID-19

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

https://jembi.github.io/covid19-immunization-ig//StructureDefinition/covid19-immunization

Formal Views of Profile Content

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

This structure is derived from Immunization

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 3 elements

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... last-dose 1..1booleanOptional Extensions Element
URL: https://jembi.github.io/covid19-immunization-ig//StructureDefinition/last-dose
... dose-given 1..1booleanOptional Extensions Element
URL: https://jembi.github.io/covid19-immunization-ig//StructureDefinition/dose-given
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason 0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.

... vaccineCode SΣ1..1CodeableConceptVaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

... patient Σ1..1Reference(Patient)Who was immunized
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] Σ1..1(Slice Definition)Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ1..1dateTimeVaccine administration date
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... location 0..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

... route 0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.

... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer Σ0..*BackboneElementWho performed event
.... 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..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference 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
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows 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
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... 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
.... series 0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.


.... doseNumber[x] 1..1(Slice Definition)Dose number within series
Slice: Unordered, Closed by type:$this
..... doseNumber[x]:doseNumberPositiveInt S1..1positiveIntDose number within series
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... vaccineCode Σ1..1CodeableConceptVaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

... occurrence[x]:occurrenceDateTime Σ1..1dateTimeVaccine administration date
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... doseNumber[x]:doseNumberPositiveInt 1..1positiveIntDose number within series

doco Documentation for this format

This structure is derived from Immunization

Summary

Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 3 elements

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... last-dose 1..1booleanOptional Extensions Element
URL: https://jembi.github.io/covid19-immunization-ig//StructureDefinition/last-dose
... dose-given 1..1booleanOptional Extensions Element
URL: https://jembi.github.io/covid19-immunization-ig//StructureDefinition/dose-given
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason 0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.

... vaccineCode SΣ1..1CodeableConceptVaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

... patient Σ1..1Reference(Patient)Who was immunized
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] Σ1..1(Slice Definition)Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ1..1dateTimeVaccine administration date
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... location 0..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

... route 0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.

... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer Σ0..*BackboneElementWho performed event
.... 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..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference 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
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows 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
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied 0..*BackboneElementProtocol followed by the provider
.... 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
.... series 0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.


.... doseNumber[x] 1..1(Slice Definition)Dose number within series
Slice: Unordered, Closed by type:$this
..... doseNumber[x]:doseNumberPositiveInt S1..1positiveIntDose number within series
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonexampleImmunizationStatusReasonCodes
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
Immunization.routeexampleImmunizationRouteCodes
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes

Constraints

IdPathDetailsRequirements
dom-2ImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ImmunizationIf 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-4ImmunizationIf 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-5ImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1Immunization.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.extension:lastDoseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.extension:lastDoseMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.extension:doseGivenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.extension:doseGivenMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.statusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.occurrence[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.occurrence[x]:occurrenceDateTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.recordedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.primarySourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reportOriginAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.manufacturerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.lotNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.expirationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.siteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.routeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.doseQuantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performer.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.performer.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.performer.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.performer.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.performer.functionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performer.actorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.isSubpotentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.subpotentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.educationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
imm-1Immunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()
ele-1Immunization.education.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.education.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.education.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.education.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.education.documentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.education.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.education.publicationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.education.presentationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.programEligibilityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.fundingSourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reactionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reaction.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.reaction.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.reaction.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.reaction.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.reaction.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reaction.detailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reaction.reportedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolAppliedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.protocolApplied.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.protocolApplied.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.protocolApplied.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.protocolApplied.seriesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.authorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.targetDiseaseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.doseNumber[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveIntAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.seriesDoses[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())