Mongolian HDIT Implementation guide
1.0.0 - Review

Mongolian HDIT Implementation guide - Local Development build (v1.0.0). See the Directory of published versions

StructureDefinition: ImmunizationMn

Documentation about a medical encounter where an immunization is performed as a singular occurrence or a part of a series.

The official URL for this profile is: 

http://fhir.mn/StructureDefinition/mng-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: 13 elements (3 nested mandatory elements)
Must-Support: 45 elements
Prohibited: 15 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Immunization.occurrence[x] is sliced based on the value of type:$this
  • The element Immunization.protocolApplied.doseNumber[x] is sliced based on the value of type:$this
  • The element Immunization.protocolApplied.seriesDoses[x] is sliced based on the value of type:$this

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... extension 4..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccination-consent S0..1booleanConsent for vaccination
URL: http://fhir.mn/StructureDefinition/vaccination-consent
... vaccination-consent-guardian S0..1booleanConsent from legal guardian
URL: http://fhir.mn/StructureDefinition/vaccination-consent-guardian
... vaccination-type S1..1CodeableConceptType of vaccination (Live | Inactive | Subunit | Recombinant | Polysaccharide | Conjugate | Tox)
URL: http://fhir.mn/StructureDefinition/vaccination-type
... patient-occupation S0..1CodeableConceptOccupation if the indication is epidemiological vaccination ( Medical doctors and practitioners - 1, Soldiers, Polices, Custom and Border Protection Officers - 2, People in the region of the outbreak of infectious disease - 3, Veterinarians and people who interact with animal raw materials - 4, plumber locksmiths and janitors - 5, mechanics and locksmiths work for sewage treatment plant - 6, inhabitants of natural infection hotspots - 7, travelers to countries with infectious outbreak - 8, other - 9 )
URL: http://fhir.mn/StructureDefinition/patient-occupation
... vaccine-serial-number S1..1stringExtension
URL: http://fhir.mn/StructureDefinition/vaccine-serial-number
... information-to-patient S0..1stringReccommendation to patient
URL: http://fhir.mn/StructureDefinition/information-to-patient
... vaccination-complete-datetime S1..1dateTimeDate and time complete
URL: http://fhir.mn/StructureDefinition/vaccination-complete-datetime
... next-routine-vaccination-datetime S0..1dateTimeDate of the next routine vaccination
URL: http://fhir.mn/StructureDefinition/next-routine-vaccination-datetime
... vaccine-concentration S1..1QuantityВакцины хэмжээ
URL: http://fhir.mn/StructureDefinition/vaccine-concentration
... status 1..1codecompleted | entered-in-error | not-done
Required Pattern: completed
... statusReason S0..0
... vaccineCode S1..1CodeableConceptVaccine product administered
... patient S1..1Reference(PatientMn)Who was immunized
... encounter S0..0
... occurrence[x] S1..1(Slice Definition)Vaccine administration date
Slice: Unordered, Open by type:$this
... occurrenceDateTime 1..1dateTimeVaccine administration date
... recorded S0..0
... primarySource S0..0
... reportOrigin S0..0
... location S1..1Reference(Location mn)Where immunization occurred
... manufacturer S1..1Reference(ManufacturerMn)Vaccine manufacturer
... lotNumber S1..1stringVaccine lot number
... expirationDate S1..1dateVaccine expiration date
... site S1..1CodeableConceptBody site vaccine was administered
... route S1..1CodeableConceptHow vaccine entered body
... doseQuantity S1..1SimpleQuantityAmount of vaccine administered
... performer S0..*BackboneElementWho performed event
.... actor S1..1Reference(PractitionerRoleMn)Individual or organization who was performing
... note S0..0
... reasonCode S1..*CodeableConceptIndication of vaccine ( Mandatory | Voluntary | Additional | Compensatory | Epidemiological )
Binding: Vaccination reasons (required)
... reasonReference S0..0
... isSubpotent S0..0
... subpotentReason S0..0
... education S0..0
... programEligibility S0..0
... fundingSource S0..0
... reaction S0..*BackboneElementDetails of a reaction that follows immunization
.... date S1..1dateTimeWhen reaction started
.... detail S1..1Reference(Observation)Additional information on reaction
.... reported S0..0
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... disease-causative-agent S0..1stringExtension
URL: http://fhir.mn/StructureDefinition/disease-causative-agent
.... series S0..0
.... authority S0..0
.... targetDisease S0..*CodeableConceptVaccine preventatable disease being targetted
.... doseNumber[x] S1..1(Slice Definition)Dose number within series
Slice: Unordered, Open by type:$this
.... doseNumberPositiveInt 1..1positiveIntDose number within series
.... seriesDoses[x] S0..1(Slice Definition)Recommended number of doses for immunity
Slice: Unordered, Open by type:$this
.... seriesDosesPositiveInt 0..1positiveIntRecommended number of doses for immunity

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*ImmunizationImmunization event information
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I4..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccination-consent SI0..1booleanConsent for vaccination
URL: http://fhir.mn/StructureDefinition/vaccination-consent
... vaccination-consent-guardian SI0..1booleanConsent from legal guardian
URL: http://fhir.mn/StructureDefinition/vaccination-consent-guardian
... vaccination-type SI1..1CodeableConceptType of vaccination (Live | Inactive | Subunit | Recombinant | Polysaccharide | Conjugate | Tox)
URL: http://fhir.mn/StructureDefinition/vaccination-type
... patient-occupation SI0..1CodeableConceptOccupation if the indication is epidemiological vaccination ( Medical doctors and practitioners - 1, Soldiers, Polices, Custom and Border Protection Officers - 2, People in the region of the outbreak of infectious disease - 3, Veterinarians and people who interact with animal raw materials - 4, plumber locksmiths and janitors - 5, mechanics and locksmiths work for sewage treatment plant - 6, inhabitants of natural infection hotspots - 7, travelers to countries with infectious outbreak - 8, other - 9 )
URL: http://fhir.mn/StructureDefinition/patient-occupation
... vaccine-serial-number SI1..1stringExtension
URL: http://fhir.mn/StructureDefinition/vaccine-serial-number
... information-to-patient SI0..1stringReccommendation to patient
URL: http://fhir.mn/StructureDefinition/information-to-patient
... vaccination-complete-datetime SI1..1dateTimeDate and time complete
URL: http://fhir.mn/StructureDefinition/vaccination-complete-datetime
... next-routine-vaccination-datetime SI0..1dateTimeDate of the next routine vaccination
URL: http://fhir.mn/StructureDefinition/next-routine-vaccination-datetime
... vaccine-concentration SI1..1QuantityВакцины хэмжээ
URL: http://fhir.mn/StructureDefinition/vaccine-concentration
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierBusiness identifier
... status ?!ΣI1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
Required Pattern: completed
... vaccineCode SΣI1..1CodeableConceptVaccine product administered
Binding: VaccineAdministeredValueSet (example)
... patient SΣI1..1Reference(PatientMn)Who was immunized
... occurrence[x] SΣI1..1(Slice Definition)Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime ΣI1..1dateTimeVaccine administration date
... location SI1..1Reference(Location mn)Where immunization occurred
... manufacturer SI1..1Reference(ManufacturerMn)Vaccine manufacturer
... lotNumber SI1..1stringVaccine lot number
... expirationDate SI1..1dateVaccine expiration date
... site SI1..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
... route SI1..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example)
... doseQuantity SI1..1SimpleQuantityAmount of vaccine administered
... performer SΣI0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function ΣI0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible)
.... actor SΣI1..1Reference(PractitionerRoleMn)Individual or organization who was performing
... reasonCode SI1..*CodeableConceptIndication of vaccine ( Mandatory | Voluntary | Additional | Compensatory | Epidemiological )
Binding: Vaccination reasons (required)
... reaction SI0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date SI1..1dateTimeWhen reaction started
.... detail SI1..1Reference(Observation)Additional information on reaction
... protocolApplied SI0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... disease-causative-agent SI0..1stringExtension
URL: http://fhir.mn/StructureDefinition/disease-causative-agent
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... targetDisease SI0..*CodeableConceptVaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber[x] SI1..1(Slice Definition)Dose number within series
Slice: Unordered, Closed by type:$this
..... doseNumber[x]:doseNumberPositiveInt I1..1positiveIntDose number within series
.... seriesDoses[x] SI0..1(Slice Definition)Recommended number of doses for immunity
Slice: Unordered, Closed by type:$this
..... seriesDoses[x]:seriesDosesPositiveInt I0..1positiveIntRecommended number of doses for immunity

doco Documentation for this format

This structure is derived from Immunization

Summary

Mandatory: 13 elements (3 nested mandatory elements)
Must-Support: 45 elements
Prohibited: 15 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Immunization.occurrence[x] is sliced based on the value of type:$this
  • The element Immunization.protocolApplied.doseNumber[x] is sliced based on the value of type:$this
  • The element Immunization.protocolApplied.seriesDoses[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... extension 4..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccination-consent S0..1booleanConsent for vaccination
URL: http://fhir.mn/StructureDefinition/vaccination-consent
... vaccination-consent-guardian S0..1booleanConsent from legal guardian
URL: http://fhir.mn/StructureDefinition/vaccination-consent-guardian
... vaccination-type S1..1CodeableConceptType of vaccination (Live | Inactive | Subunit | Recombinant | Polysaccharide | Conjugate | Tox)
URL: http://fhir.mn/StructureDefinition/vaccination-type
... patient-occupation S0..1CodeableConceptOccupation if the indication is epidemiological vaccination ( Medical doctors and practitioners - 1, Soldiers, Polices, Custom and Border Protection Officers - 2, People in the region of the outbreak of infectious disease - 3, Veterinarians and people who interact with animal raw materials - 4, plumber locksmiths and janitors - 5, mechanics and locksmiths work for sewage treatment plant - 6, inhabitants of natural infection hotspots - 7, travelers to countries with infectious outbreak - 8, other - 9 )
URL: http://fhir.mn/StructureDefinition/patient-occupation
... vaccine-serial-number S1..1stringExtension
URL: http://fhir.mn/StructureDefinition/vaccine-serial-number
... information-to-patient S0..1stringReccommendation to patient
URL: http://fhir.mn/StructureDefinition/information-to-patient
... vaccination-complete-datetime S1..1dateTimeDate and time complete
URL: http://fhir.mn/StructureDefinition/vaccination-complete-datetime
... next-routine-vaccination-datetime S0..1dateTimeDate of the next routine vaccination
URL: http://fhir.mn/StructureDefinition/next-routine-vaccination-datetime
... vaccine-concentration S1..1QuantityВакцины хэмжээ
URL: http://fhir.mn/StructureDefinition/vaccine-concentration
... status 1..1codecompleted | entered-in-error | not-done
Required Pattern: completed
... statusReason S0..0
... vaccineCode S1..1CodeableConceptVaccine product administered
... patient S1..1Reference(PatientMn)Who was immunized
... encounter S0..0
... occurrence[x] S1..1(Slice Definition)Vaccine administration date
Slice: Unordered, Open by type:$this
... occurrenceDateTime 1..1dateTimeVaccine administration date
... recorded S0..0
... primarySource S0..0
... reportOrigin S0..0
... location S1..1Reference(Location mn)Where immunization occurred
... manufacturer S1..1Reference(ManufacturerMn)Vaccine manufacturer
... lotNumber S1..1stringVaccine lot number
... expirationDate S1..1dateVaccine expiration date
... site S1..1CodeableConceptBody site vaccine was administered
... route S1..1CodeableConceptHow vaccine entered body
... doseQuantity S1..1SimpleQuantityAmount of vaccine administered
... performer S0..*BackboneElementWho performed event
.... actor S1..1Reference(PractitionerRoleMn)Individual or organization who was performing
... note S0..0
... reasonCode S1..*CodeableConceptIndication of vaccine ( Mandatory | Voluntary | Additional | Compensatory | Epidemiological )
Binding: Vaccination reasons (required)
... reasonReference S0..0
... isSubpotent S0..0
... subpotentReason S0..0
... education S0..0
... programEligibility S0..0
... fundingSource S0..0
... reaction S0..*BackboneElementDetails of a reaction that follows immunization
.... date S1..1dateTimeWhen reaction started
.... detail S1..1Reference(Observation)Additional information on reaction
.... reported S0..0
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... disease-causative-agent S0..1stringExtension
URL: http://fhir.mn/StructureDefinition/disease-causative-agent
.... series S0..0
.... authority S0..0
.... targetDisease S0..*CodeableConceptVaccine preventatable disease being targetted
.... doseNumber[x] S1..1(Slice Definition)Dose number within series
Slice: Unordered, Open by type:$this
.... doseNumberPositiveInt 1..1positiveIntDose number within series
.... seriesDoses[x] S0..1(Slice Definition)Recommended number of doses for immunity
Slice: Unordered, Open by type:$this
.... seriesDosesPositiveInt 0..1positiveIntRecommended number of doses for immunity

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*ImmunizationImmunization event information
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I4..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccination-consent SI0..1booleanConsent for vaccination
URL: http://fhir.mn/StructureDefinition/vaccination-consent
... vaccination-consent-guardian SI0..1booleanConsent from legal guardian
URL: http://fhir.mn/StructureDefinition/vaccination-consent-guardian
... vaccination-type SI1..1CodeableConceptType of vaccination (Live | Inactive | Subunit | Recombinant | Polysaccharide | Conjugate | Tox)
URL: http://fhir.mn/StructureDefinition/vaccination-type
... patient-occupation SI0..1CodeableConceptOccupation if the indication is epidemiological vaccination ( Medical doctors and practitioners - 1, Soldiers, Polices, Custom and Border Protection Officers - 2, People in the region of the outbreak of infectious disease - 3, Veterinarians and people who interact with animal raw materials - 4, plumber locksmiths and janitors - 5, mechanics and locksmiths work for sewage treatment plant - 6, inhabitants of natural infection hotspots - 7, travelers to countries with infectious outbreak - 8, other - 9 )
URL: http://fhir.mn/StructureDefinition/patient-occupation
... vaccine-serial-number SI1..1stringExtension
URL: http://fhir.mn/StructureDefinition/vaccine-serial-number
... information-to-patient SI0..1stringReccommendation to patient
URL: http://fhir.mn/StructureDefinition/information-to-patient
... vaccination-complete-datetime SI1..1dateTimeDate and time complete
URL: http://fhir.mn/StructureDefinition/vaccination-complete-datetime
... next-routine-vaccination-datetime SI0..1dateTimeDate of the next routine vaccination
URL: http://fhir.mn/StructureDefinition/next-routine-vaccination-datetime
... vaccine-concentration SI1..1QuantityВакцины хэмжээ
URL: http://fhir.mn/StructureDefinition/vaccine-concentration
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierBusiness identifier
... status ?!ΣI1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
Required Pattern: completed
... vaccineCode SΣI1..1CodeableConceptVaccine product administered
Binding: VaccineAdministeredValueSet (example)
... patient SΣI1..1Reference(PatientMn)Who was immunized
... occurrence[x] SΣI1..1(Slice Definition)Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime ΣI1..1dateTimeVaccine administration date
... location SI1..1Reference(Location mn)Where immunization occurred
... manufacturer SI1..1Reference(ManufacturerMn)Vaccine manufacturer
... lotNumber SI1..1stringVaccine lot number
... expirationDate SI1..1dateVaccine expiration date
... site SI1..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
... route SI1..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example)
... doseQuantity SI1..1SimpleQuantityAmount of vaccine administered
... performer SΣI0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function ΣI0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible)
.... actor SΣI1..1Reference(PractitionerRoleMn)Individual or organization who was performing
... reasonCode SI1..*CodeableConceptIndication of vaccine ( Mandatory | Voluntary | Additional | Compensatory | Epidemiological )
Binding: Vaccination reasons (required)
... reaction SI0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date SI1..1dateTimeWhen reaction started
.... detail SI1..1Reference(Observation)Additional information on reaction
... protocolApplied SI0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... disease-causative-agent SI0..1stringExtension
URL: http://fhir.mn/StructureDefinition/disease-causative-agent
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... targetDisease SI0..*CodeableConceptVaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber[x] SI1..1(Slice Definition)Dose number within series
Slice: Unordered, Closed by type:$this
..... doseNumber[x]:doseNumberPositiveInt I1..1positiveIntDose number within series
.... seriesDoses[x] SI0..1(Slice Definition)Recommended number of doses for immunity
Slice: Unordered, Closed by type:$this
..... seriesDoses[x]:seriesDosesPositiveInt I0..1positiveIntRecommended number of doses for immunity

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Immunization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Immunization.statusrequiredPattern: completed
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
Immunization.routeexampleImmunizationRouteCodes
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCoderequiredVaccinationReasonsVS
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes

Constraints

Constraints

IdPathDetailsRequirements