ImplementationGuide for Malaysia Core (MY Core)
0.0.1 - CI Build

ImplementationGuide for Malaysia Core (MY Core), published by Malaysia Healthcare Nexus (MHN). This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nhphong245/my-core-ig-r4/ and changes regularly. See the Directory of published versions

Resource Profile:

Official URL: http://fhir.hie.moh.gov.my/StructureDefinition/ImmunizationRecommendation-my-core Version: 0.0.1
Active as of 2024-03-13 Responsible: Malaysia Healthcare Nexus (MHN) Realm: International flag Computable Name: ImmunizationRecommendation

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... recommendation 1..1 BackboneElement Vaccine administration recommendations
.... Slices for extension Content/Rules for all slices
..... booster 0..1 boolean Extension to determine if the vaccine is a booster dose
URL: http://fhir.hie.moh.gov.my/StructureDefinition/extension-booster-my-core
.... vaccineCode 1..1 CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: ValueSetVaccineCode (MY Core) (required)
.... forecastStatus 1..1 CodeableConcept Vaccine recommendation status
Binding: ValueSetImmunizationRecommendationStatus (MY Core) (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ImmunizationRecommendation.recommendation.vaccineCoderequiredValueSetVaccineCodeMyCore (a valid code from CodeSystemVaccineCode (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/vaccine-code-my-core
from this IG
ImmunizationRecommendation.recommendation.forecastStatuspreferredValueSetImmunizationRecommendationStatusMyCore (a valid code from CodeSystemImmunizationRecommendationStatus (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/immunization-recommendation-status-my-core
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient Σ 1..1 Reference(Patient) Who this profile is for
... recommendation ΣC 1..1 BackboneElement Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... Slices for extension Content/Rules for all slices
..... booster 0..1 boolean Extension to determine if the vaccine is a booster dose
URL: http://fhir.hie.moh.gov.my/StructureDefinition/extension-booster-my-core
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineCode Σ 1..1 CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: ValueSetVaccineCode (MY Core) (required)
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: ValueSetImmunizationRecommendationStatus (MY Core) (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationRecommendation.recommendation.vaccineCoderequiredValueSetVaccineCodeMyCore (a valid code from CodeSystemVaccineCode (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/vaccine-code-my-core
from this IG
ImmunizationRecommendation.recommendation.forecastStatuspreferredValueSetImmunizationRecommendationStatusMyCore (a valid code from CodeSystemImmunizationRecommendationStatus (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/immunization-recommendation-status-my-core
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf 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-4errorImmunizationRecommendationIf 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-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... patient Σ 1..1 Reference(Patient) Who this profile is for
... date Σ 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(Organization) Who is responsible for protocol
... recommendation ΣC 1..1 BackboneElement Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... booster 0..1 boolean Extension to determine if the vaccine is a booster dose
URL: http://fhir.hie.moh.gov.my/StructureDefinition/extension-booster-my-core
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineCode Σ 1..1 CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: ValueSetVaccineCode (MY Core) (required)
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.

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


.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: ValueSetImmunizationRecommendationStatus (MY Core) (preferred)
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.


.... dateCriterion 0..* BackboneElement Dates governing proposed immunization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Type 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..1 dateTime Recommended date
.... description 0..1 string Protocol details
.... series 0..1 string Name of vaccination series
.... doseNumber[x] Σ 0..1 Recommended dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string
.... supportingImmunization 0..* Reference(Immunization | ImmunizationEvaluation) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationRecommendation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCoderequiredValueSetVaccineCodeMyCore (a valid code from CodeSystemVaccineCode (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/vaccine-code-my-core
from this IG
ImmunizationRecommendation.recommendation.targetDiseaseexampleImmunizationRecommendationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease
from the FHIR Standard
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatuspreferredValueSetImmunizationRecommendationStatusMyCore (a valid code from CodeSystemImmunizationRecommendationStatus (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/immunization-recommendation-status-my-core
from this IG
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-reason
from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf 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-4errorImmunizationRecommendationIf 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-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendation

Summary

Mandatory: 1 element

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... recommendation 1..1 BackboneElement Vaccine administration recommendations
.... Slices for extension Content/Rules for all slices
..... booster 0..1 boolean Extension to determine if the vaccine is a booster dose
URL: http://fhir.hie.moh.gov.my/StructureDefinition/extension-booster-my-core
.... vaccineCode 1..1 CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: ValueSetVaccineCode (MY Core) (required)
.... forecastStatus 1..1 CodeableConcept Vaccine recommendation status
Binding: ValueSetImmunizationRecommendationStatus (MY Core) (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ImmunizationRecommendation.recommendation.vaccineCoderequiredValueSetVaccineCodeMyCore (a valid code from CodeSystemVaccineCode (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/vaccine-code-my-core
from this IG
ImmunizationRecommendation.recommendation.forecastStatuspreferredValueSetImmunizationRecommendationStatusMyCore (a valid code from CodeSystemImmunizationRecommendationStatus (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/immunization-recommendation-status-my-core
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient Σ 1..1 Reference(Patient) Who this profile is for
... recommendation ΣC 1..1 BackboneElement Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... Slices for extension Content/Rules for all slices
..... booster 0..1 boolean Extension to determine if the vaccine is a booster dose
URL: http://fhir.hie.moh.gov.my/StructureDefinition/extension-booster-my-core
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineCode Σ 1..1 CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: ValueSetVaccineCode (MY Core) (required)
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: ValueSetImmunizationRecommendationStatus (MY Core) (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationRecommendation.recommendation.vaccineCoderequiredValueSetVaccineCodeMyCore (a valid code from CodeSystemVaccineCode (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/vaccine-code-my-core
from this IG
ImmunizationRecommendation.recommendation.forecastStatuspreferredValueSetImmunizationRecommendationStatusMyCore (a valid code from CodeSystemImmunizationRecommendationStatus (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/immunization-recommendation-status-my-core
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf 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-4errorImmunizationRecommendationIf 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-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... patient Σ 1..1 Reference(Patient) Who this profile is for
... date Σ 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(Organization) Who is responsible for protocol
... recommendation ΣC 1..1 BackboneElement Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... booster 0..1 boolean Extension to determine if the vaccine is a booster dose
URL: http://fhir.hie.moh.gov.my/StructureDefinition/extension-booster-my-core
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineCode Σ 1..1 CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: ValueSetVaccineCode (MY Core) (required)
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.

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


.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: ValueSetImmunizationRecommendationStatus (MY Core) (preferred)
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.


.... dateCriterion 0..* BackboneElement Dates governing proposed immunization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Type 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..1 dateTime Recommended date
.... description 0..1 string Protocol details
.... series 0..1 string Name of vaccination series
.... doseNumber[x] Σ 0..1 Recommended dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string
.... supportingImmunization 0..* Reference(Immunization | ImmunizationEvaluation) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationRecommendation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCoderequiredValueSetVaccineCodeMyCore (a valid code from CodeSystemVaccineCode (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/vaccine-code-my-core
from this IG
ImmunizationRecommendation.recommendation.targetDiseaseexampleImmunizationRecommendationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease
from the FHIR Standard
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatuspreferredValueSetImmunizationRecommendationStatusMyCore (a valid code from CodeSystemImmunizationRecommendationStatus (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/immunization-recommendation-status-my-core
from this IG
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-reason
from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf 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-4errorImmunizationRecommendationIf 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-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendation

Summary

Mandatory: 1 element

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron