電子カルテ情報共有サービス2文書5情報+患者サマリー FHIR実装ガイド JP-CLINS(CLinical Information Sharing ImplementationGuide) v1.7.1
1.7.1 - release
Japan
項目 | 内容 |
定義URL | http://jpfhir.jp/fhir/eCS/StructureDefinition/JP_Immunization_eCS |
Version | 1.7.1 |
Name | JP_Immunization_eCS |
Status | Active ( 2024-09-14 ) |
Copyright | (一社)日本医療情報学会. CC BY-ND 4.0 |
Derived Profile from JP-Core
Usage:
This structure is derived from JP_Immunization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | JP_Immunization | |||
meta | ||||
lastUpdated | S | 0..1 | instant | リソースのバージョンが最後に変更されたとき |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Immunization | 0..* | JP_Immunization | 予防接種 | |||||
id | Σ | 0..1 | id | このResourceに対する論理ID | ||||
meta | Σ | 0..1 | Meta | リソースに関するメタデータ / Metadata about the resource | ||||
id | 0..1 | string | エレメント相互参照のためのユニークID | |||||
extension | 0..* | Extension | 実装によって定義される追加コンテンツ Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | バージョン固有のidentifier (Baajon koyū no shikibetsu-shi) | ||||
lastUpdated | SΣ | 0..1 | instant | リソースのバージョンが最後に変更されたとき | ||||
source | Σ | 0..1 | uri | リソースがどこから来たかを特定する | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | このリソースが適合を主張するプロファイル | ||||
security | Σ | 0..* | Coding | このリソースに適用されたセキュリティラベル Binding: All Security Labels (extensible): 医療プライバシーおよびセキュリティ分類システムからのセキュリティラベル。 | ||||
tag | Σ | 0..* | Coding | このリソースに適用されたタグ | ||||
implicitRules | ?!Σ | 0..1 | uri | このコンテンツが作成されたルールのセット / A set of rules under which this content was created | ||||
language | 0..1 | code | リソースコンテンツの言語 / Language of the resource content Binding: CommonLanguages (preferred): 人間の言語。 / A human language.
| |||||
text | 0..1 | Narrative | 人間の解釈のためのリソースのテキスト概要 / Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | インラインリソースが含まれています / Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | 実装で定義された追加のコンテンツ / Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
dueDateOfNextDose | 0..1 | date | 実装で定義された追加のコンテンツ / Additional content defined by implementations URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Immunization_DueDateOfNextDose | |||||
manufacturedDate | 0..1 | date | 実装で定義された追加のコンテンツ / Additional content defined by implementations URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Immunization_ManufacturedDate | |||||
certificatedDate | 0..1 | date | 実装で定義された追加のコンテンツ / Additional content defined by implementations URL: http://jpfhir.jp/fhir/core/Extension/StructureDefinition/JP_Immunization_CertificatedDate | |||||
modifierExtension | ?! | 0..* | Extension | 無視できない拡張機能 / Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | ビジネス識別子 / Business identifier | |||||
status | ?!Σ | 1..1 | code | 完了|エラーに入った|まだ完成してない / completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): 予防接種の現在の状態を表すコード | ||||
statusReason | 0..1 | CodeableConcept | 実施しなかった理由 Binding: ImmunizationStatusReasonCodes (example): ワクチンが投与されなかった理由。 / The reason why a vaccine was not administered. | |||||
vaccineCode | Σ | 1..1 | CodeableConcept | 接種されたワクチン製剤 Binding: JP Core MedicationCode Immunization ValueSet (preferred) | ||||
patient | Σ | 1..1 | Reference(JP Core Patient Profile) | 予防接種を受けた人 | ||||
encounter | 0..1 | Reference(JP Core Encounter Profile) | 予防接種を受けた診察 | |||||
occurrence[x] | Σ | 1..1 | ワクチンを接種した日時 | |||||
occurrenceDateTime | dateTime | |||||||
occurrenceString | string | |||||||
recorded | 0..1 | dateTime | 予防接種を受けた対象者の記録として最初に記載された日 | |||||
primarySource | Σ | 0..1 | boolean | データが記録されたコンテキストを示します / Indicates context the data was recorded in | ||||
reportOrigin | 0..1 | CodeableConcept | 二次的に報告された記録の発生源を示す Binding: ImmunizationOriginCodes (example): 主要なソースからのものではないレコードのデータのソース。 / The source of the data for a record which is not from a primary source. | |||||
location | 0..1 | Reference(JP Core Location Profile) | ワクチンを接種した場所 | |||||
manufacturer | 0..1 | Reference(JP Core Organization Profile) | ワクチンメーカー | |||||
lotNumber | 0..1 | string | ワクチンのロット番号 | |||||
expirationDate | 0..1 | date | ワクチンの使用期限 | |||||
site | 0..1 | CodeableConcept | ワクチンが接種された身体部位 Binding: CodesForImmunizationSiteOfAdministration (example): ワクチンが投与されたサイト。 / The site at which the vaccine was administered. | |||||
route | 0..1 | CodeableConcept | ワクチンを接種した経路 Binding: ImmunizationRouteCodes (example): ワクチンが投与されたルート。 / The route by which the vaccine was administered. | |||||
doseQuantity | 0..1 | JP_MedicationSimpleQuantity | ワクチンの投与量 | |||||
performer | Σ | 0..* | BackboneElement | ワクチン接種を実施した人 | ||||
id | 0..1 | string | 要素間参照のための一意のID / 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 | ||||
function | Σ | 0..1 | CodeableConcept | どのような種類のパフォーマンスが行われました / What type of performance was done Binding: ImmunizationFunctionCodes (extensible): 予防接種イベントで開業医または組織が果たす役割。 / The role a practitioner or organization plays in the immunization event. | ||||
actor | Σ | 1..1 | Reference(JP Core Practitioner Profile | JP Core PractitionerRole Profile | JP Core Organization Profile) | 演奏していた個人または組織 / Individual or organization who was performing | ||||
note | Σ | 0..* | Annotation | 予防接種についての補足的記録 | ||||
reasonCode | 0..* | CodeableConcept | 予防接種を接種した理由 Binding: ImmunizationReasonCodes (example): ワクチンが投与された理由。 / The reason why a vaccine was administered. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | 予防接種を実施した理由 | |||||
isSubpotent | ?!Σ | 0..1 | boolean | 効力量 | ||||
subpotentReason | 0..* | CodeableConcept | 効力が減弱する理由 Binding: ImmunizationSubpotentReason (example): 用量がサブポテントと見なされる理由。 / The reason why a dose is considered to be subpotent. | |||||
education | C | 0..* | BackboneElement | 患者に提示された教材 imm-1: DocumentTypeまたは参照の1つが存在するものとします / One of documentType or reference SHALL be present | ||||
id | 0..1 | string | 要素間参照のための一意のID / 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 | ||||
documentType | 0..1 | string | 教育資料文書識別子 / Educational material document identifier | |||||
reference | 0..1 | uri | 教育資料の参照ポインター / Educational material reference pointer | |||||
publicationDate | 0..1 | dateTime | 教育資料の出版日 / Educational material publication date | |||||
presentationDate | 0..1 | dateTime | 教育資料の提示日 / Educational material presentation date | |||||
programEligibility | 0..* | CodeableConcept | ワクチン接種計画での患者適格性 Binding: ImmunizationProgramEligibility (example): 患者の予防接種プログラムの適格性。 / The patient's eligibility for a vaccation program. | |||||
fundingSource | 0..1 | CodeableConcept | ワクチン接種計画のの資金源 Binding: ImmunizationFundingSource (example): 投与されたワクチンの購入に使用される資金源。 / The source of funding used to purchase the vaccine administered. | |||||
reaction | 0..* | BackboneElement | 予防接種後に起こった反応についての詳細な記録 | |||||
id | 0..1 | string | 要素間参照のための一意のID / 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 | ||||
date | 0..1 | dateTime | 反応が始まったとき / When reaction started | |||||
detail | 0..1 | Reference(Observation) | 反応に関する追加情報 / Additional information on reaction | |||||
reported | 0..1 | boolean | 自己申告による反応を示します / Indicates self-reported reaction | |||||
protocolApplied | 0..* | BackboneElement | 提供者が実施したプロトコール | |||||
id | 0..1 | string | 要素間参照のための一意のID / 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 | ||||
series | 0..1 | string | ワクチンシリーズの名前 / Name of vaccine series | |||||
authority | 0..1 | Reference(Organization) | 推奨事項を公開する責任者は誰ですか / Who is responsible for publishing the recommendations | |||||
targetDisease | 0..* | CodeableConcept | ワクチン予防可能な病気が標的にされています / Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): ワクチン予防可能な疾患用量が投与されています。 / The vaccine preventable disease the dose is being administered for. | |||||
doseNumber[x] | 1..1 | シリーズ内の用量数 / Dose number within series | ||||||
doseNumberPositiveInt | positiveInt | |||||||
doseNumberString | string | |||||||
seriesDoses[x] | 0..1 | 免疫のために推奨される用量数 / Recommended number of doses for immunity | ||||||
seriesDosesPositiveInt | positiveInt | |||||||
seriesDosesString | string | |||||||
Documentation for this format |
Terminology バインディング
Path | Conformance | ValueSet | URI | |||
Immunization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Immunization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | ||||
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard | ||||
Immunization.vaccineCode | preferred | JP_MedicationCode_Immunization_VShttp://jpfhir.jp/fhir/core/ValueSet/JP_MedicationCode_Immunization_VS | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard | ||||
Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard | ||||
Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard | ||||
Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | ||||
Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard | ||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard | ||||
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard |
Constraints
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Immunization | リソースが別のリソースに含まれている場合、ネストされたリソースを含めてはなりません / If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Immunization | リソースが別のリソースに含まれている場合、それはリソースの他の場所から参照されるか、含有リソースを参照するものとします / If 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-4 | error | Immunization | リソースが別のリソースに含まれている場合、meta.versionidまたはmeta.lastupdatedを持たないものとします / If 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-5 | error | Immunization | 別のリソースにリソースが含まれている場合、セキュリティラベルはありません / If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Immunization | リソースには、堅牢な管理のための叙述(Narative)が必要です / A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | すべてのFHIR要素には、@valueまたは子供が必要です / All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | 拡張機能または値[x]のいずれかが必要です。両方ではありません。 : extension.exists() != value.exists() | |
imm-1 | error | Immunization.education | DocumentTypeまたは参照の1つが存在するものとします / One of documentType or reference SHALL be present : documentType.exists() or reference.exists() |