FHIR JP Core CI/CD実験
1.0.0 - ci-build

FHIR JP Core CI/CD実験 - Local Development build (v1.0.0). See the Directory of published versions

Resource Profile: JP_Immunization

Official URL: http://jpfhir.jp/fhir/core/StructureDefinition/JP_Immunization Version: 1.0.0
Active as of 2022-04-01 Computable Name: JP_Immunization

Copyright/Legal: FHIR® Japanese implementation research working group in Japan Association of Medical Informatics (JAMI)

このプロファイルはImmunizationリソースに対して日本での運用を視野に入れて制約を定めたたものである。

このプロファイルはImmunizationリソースに対して日本での運用を視野に入れて制約を定めたたものである。

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 Immunization

Summary

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*Immunization実施された予防接種についての記録。
... identifier 0..*IdentifierBusiness identifier
... status 1..1codecompleted | entered-in-error | not-done
... statusReason 0..1CodeableConceptReason not done
... patient 1..1Reference(Patient)予防接種を受けた者。
... encounter 0..1Reference(Encounter)予防接種を受けた診察。
... occurrence[x] 1..1dateTime, stringワクチン接種日。
... recorded 0..1dateTime予防接種を受けた対象者の記録として最初に記載された日。
... primarySource 0..1booleanデータが記録された文脈を示す。
... reportOrigin 0..1CodeableConcept二次的に報告された記録の発生源を示す。
... location 0..1Reference(Location)ワクチンを接種した場所
... manufacturer 0..1Reference(Organization)ワクチンメーカー
... lotNumber 0..1stringワクチンのロット番号

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*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
... 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 0..*ExtensionAdditional content defined by implementations
... 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 Σ1..1CodeableConcept接種されたワクチン製剤
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

... patient Σ1..1Reference(Patient)予防接種を受けた者。
... encounter 0..1Reference(Encounter)予防接種を受けた診察。
... occurrence[x] Σ1..1ワクチン接種日。
.... occurrenceDateTimedateTime
.... occurrenceStringstring
... recorded 0..1dateTime予防接種を受けた対象者の記録として最初に記載された日。
... primarySource Σ0..1booleanデータが記録された文脈を示す。
... reportOrigin 0..1CodeableConcept二次的に報告された記録の発生源を示す。
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... location 0..1Reference(Location)ワクチンを接種した場所
... manufacturer 0..1Reference(Organization)ワクチンメーカー
... lotNumber 0..1stringワクチンのロット番号
... 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
.... 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..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

This structure is derived from Immunization

Summary

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*Immunization実施された予防接種についての記録。
... identifier 0..*IdentifierBusiness identifier
... status 1..1codecompleted | entered-in-error | not-done
... statusReason 0..1CodeableConceptReason not done
... patient 1..1Reference(Patient)予防接種を受けた者。
... encounter 0..1Reference(Encounter)予防接種を受けた診察。
... occurrence[x] 1..1dateTime, stringワクチン接種日。
... recorded 0..1dateTime予防接種を受けた対象者の記録として最初に記載された日。
... primarySource 0..1booleanデータが記録された文脈を示す。
... reportOrigin 0..1CodeableConcept二次的に報告された記録の発生源を示す。
... location 0..1Reference(Location)ワクチンを接種した場所
... manufacturer 0..1Reference(Organization)ワクチンメーカー
... lotNumber 0..1stringワクチンのロット番号

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*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
... 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 0..*ExtensionAdditional content defined by implementations
... 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 Σ1..1CodeableConcept接種されたワクチン製剤
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

... patient Σ1..1Reference(Patient)予防接種を受けた者。
... encounter 0..1Reference(Encounter)予防接種を受けた診察。
... occurrence[x] Σ1..1ワクチン接種日。
.... occurrenceDateTimedateTime
.... occurrenceStringstring
... recorded 0..1dateTime予防接種を受けた対象者の記録として最初に記載された日。
... primarySource Σ0..1booleanデータが記録された文脈を示す。
... reportOrigin 0..1CodeableConcept二次的に報告された記録の発生源を示す。
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... location 0..1Reference(Location)ワクチンを接種した場所
... manufacturer 0..1Reference(Organization)ワクチンメーカー
... lotNumber 0..1stringワクチンのロット番号
... 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
.... 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..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

 

Other representations of profile: CSV, Excel, 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

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