FHIR Release 3 (STU)

Переводит компания Health Samurai . Приглашаем поучаствовать в русификации стандарта FHIR: GitHub , Email.

11.6 Ресурс Immunization - Назначение

Public Health and Emergency Response Work GroupMaturity Level: 3 Trial UseCompartments: Patient, Practitioner

Описывает событие введения пациенту вакцины или данные о вакцинации, сообщённые пациентом, медицинским специалистом или другой стороной, и может включать в себя информацию о реакции на вакцину и о протоколе вакцинации, которому при этом следовали.

Ресурс Immunization предназначен для покрытия текущих и архивных записей о введении вакцин пациентам для всех дисциплин здравоохранения, всех условий лечения и всех регионов. Сюда входит иммунизация как людей, так и животных, но не входит введение не-вакцинных агентов, даже тех, что могут иметь или заявляют, что имеют иммунологические эффекты.

Кроме того предполагается, что ресурс Immunization покроет ключевые понятия, относящиеся к созданию, проверке и выдаче запросов к истории иммунизации пациента. Данный ресурс - после консультации с рабочей группой PHER - полагаем, удовлетворит ключевые сценарии использования и информационные требования, определённые в существующем руководстве по реализации иммунизации HL7 v2 , домене HL7 v3 POIZ и Модели анализа домена иммунизации.

Данный ресурс ссылается на следующие ресурсы:

  • Patient
  • Practitioner
  • Organization
  • Location
  • Observation
  • Encounter

Для обработки введения вакцин предназначен ресурс Immunization. Ресурс MedicationAdministration предназначен для отслеживания введения не-вакцинных медикаментов. Некоторые системы обрабатывают иммунизации таким же способом, как и введение любых других медикаментов. Таким системам СЛЕДУЕТ использовать для этого ресурс immunization. Если системам необходимо использовать ресурс MedicationAdministration для записи о вакцинации в соответствии с их рабочим процессом или по другим причинам, им СЛЕДУЕТ также создавать эквивалентный экземпляр ресурса Immunization.

Ресурс AllergyIntolerance и элемент Immunization.reaction

Элемент Immunization.reaction может быть указанием на аллергию или непереносимость. Если считается, что это именно тот случай, то для него следует создать отдельный экземпляр ресурса AllergyIntolerance, поскольку большинство систем не будут делать запросы на старые значения элемента Immunization.reaction.

На этот ресурс ссылаются AdverseEvent, ChargeItem и ImmunizationRecommendation

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. Immunization IDomainResourceИнформация о событии иммунизации
+ Если иммунизация была проведена (wasNotGiven=false), тогда элемент explanation.reasonNotGiven должен отсутствовать.
+ Если иммунизация не была проведена (wasNotGiven=true), тогда элементы reaction и explanation.reason не должны присутствовать
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierБизнес-идентификатор
... status ?!Σ1..1codecompleted | entered-in-error
Immunization Status Codes (Required)
... notGiven ?!Σ1..1booleanФлаг, были ли проведена иммунизация
... vaccineCode 1..1CodeableConceptВведенная вакцина
Vaccine Administered Value Set (Example)
... patient 1..1Reference(Patient)Кому ввели вакцину?
... encounter 0..1Reference(Encounter)Случай обслуживания, в рамках которого проведена иммунизация
... date 0..1dateTimeДата вакцинации
... primarySource 1..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Immunization Origin Codes (Example)
... location 0..1Reference(Location)Где происходила вакцинация
... manufacturer 0..1Reference(Organization)Производитель вакцины
... lotNumber 0..1stringНомер партии вакцины
... expirationDate 0..1dateСрок истечения годности вакцины
... site 0..1CodeableConceptМесто на теле, куда ввели вакцину
Codes for Immunization Site of Administration (Example)
... route 0..1CodeableConceptКак вакцина попала в тело
Immunization Route Codes (Example)
... doseQuantity 0..1SimpleQuantityКоличество введенной вакцины
... practitioner Σ0..*BackboneElementWho performed event
.... role Σ0..1CodeableConceptWhat type of performance was done
Immunization Role Codes (Extensible)
.... actor Σ1..1Reference(Practitioner)Individual who was performing
... note Σ0..*AnnotationПримечания по вакцинации
... explanation 0..1BackboneElementОснование для проведения или не-проведения вакцинации
.... reason 0..*CodeableConceptПочему произошла вакцинация
Immunization Reason Codes (Example)
.... reasonNotGiven 0..*CodeableConceptПочему не была проведена иммунизация
Immunization Reasons for Not Immunizing Codes (Example)
... reaction 0..*BackboneElementСведения о реакции, которая последовала за иммунизацией
.... date 0..1dateTimeКогда началась реакция
.... detail 0..1Reference(Observation)Дополнительная информация по реакции
.... reported 0..1booleanПоказывает, что реакция записана со слов пациента
... vaccinationProtocol 0..*BackboneElementКакому протоколу следовали
.... doseSequence 0..1positiveIntНомер дозы в пределах серии
.... description 0..1stringСведения о вакцинном протоколе
.... authority 0..1Reference(Organization)Кто ответственен за протокол
.... series 0..1stringНазвание серии вакцинаций
.... seriesDoses 0..1positiveIntРекомендуемое количество доз для достижения иммунитета
.... targetDisease 1..*CodeableConceptЗаболевание, от которого проводится иммунизация
Vaccination Protocol Dose Target Codes (Example)
.... doseStatus 1..1CodeableConceptПоказывает, учитывает ли доза иммунитет
Vaccination Protocol Dose Status codes (Example)
.... doseStatusReason 0..1CodeableConceptПочему доза (не) рассчитывается по протоколу
Vaccination Protocol Dose Status Reason codes (Example)

doco Документация по этому формату

UML-диаграмма (Legend)

Immunization (DomainResource) , identifier : Identifier [0..*] (this element modifies the meaning of other elements)status : code [1..1] , (Strength=Required)Immunization Status ! , (this element modifies the meaning of other elements)notGiven : boolean [1..1], vaccineCode : CodeableConcept [1..1] (Strength=Example)Vaccine Administered Value Set?? , patient : Reference [1..1] Patient , , encounter : Reference [0..1] Encounter , date : dateTime [0..1]An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recordedprimarySource : boolean [1..1]The source of the data when the report of the immunization event is not based on information from the person who administered the vaccinereportOrigin : CodeableConcept [0..1] The source of the data for a record which is not from a primary source. (Strength=Example)Immunization Origin ?? , location : Reference [0..1] Location manufacturer : Reference [0..1] Organization lotNumber : string [0..1] expirationDate : date [0..1] , site : CodeableConcept [0..1] , (Strength=Example)Codes for Immunization Site o...?? , route : CodeableConcept [0..1] (Strength=Example)Immunization Route ?? , doseQuantity : Quantity(SimpleQuantity) [0..1] , note : Annotation [0..*]PractitionerDescribes the type of performance (e.g. ordering provider, administering provider, etc.)role : CodeableConcept [0..1] The role a practitioner plays in the immunization event (Strength=Extensible)Immunization Role + The device, practitioner, etc. who performed the actionactor : Reference [1..1] Practitioner Explanation, reason : CodeableConcept [0..*] , (Strength=Example)Immunization Reason ?? , reasonNotGiven : CodeableConcept [0..*] , (Strength=Example)Immunization Reasons for Not ...?? Reaction date : dateTime [0..1] detail : Reference [0..1] Observation , reported : boolean [0..1]VaccinationProtocol doseSequence : positiveInt [0..1] , description : string [0..1] , ? ACIPauthority : Reference [0..1] Organization - series : string [0..1] seriesDoses : positiveInt [0..1], targetDisease : CodeableConcept [1..*] , (Strength=Example)Vaccination Protocol Dose Tar...?? , doseStatus : CodeableConcept [1..1] (. . ) (Strength=Example)Vaccination Protocol Dose Sta...?? , doseStatusReason : CodeableConcept [0..1] , . (Strength=Example)Vaccination Protocol Dose Sta...?? Indicates who or what performed the eventpractitioner[0..*], explanation[0..1] , , reaction[0..*] , vaccinationProtocol[0..*]

XML-шаблон

<Immunization xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Бизнес-идентификатор --></identifier>
 <status value="[code]"/><!-- 1..1 completed | entered-in-error -->
 <notGiven value="[boolean]"/><!-- 1..1 Флаг, были ли проведена иммунизация -->
 <vaccineCode><!-- 1..1 CodeableConcept Введенная вакцина --></vaccineCode>
 <patient><!-- 1..1 Reference(Patient) Кому ввели вакцину? --></patient>
 <encounter><!-- 0..1 Reference(Encounter) Случай обслуживания, в рамках которого проведена иммунизация --></encounter>
 <date value="[dateTime]"/><!-- 0..1 Дата вакцинации -->
 <primarySource value="[boolean]"/><!-- 1..1 Indicates context the data was recorded in -->
 <reportOrigin><!-- 0..1 CodeableConcept Indicates the source of a secondarily reported record --></reportOrigin>
 <location><!-- 0..1 Reference(Location) Где происходила вакцинация --></location>
 <manufacturer><!-- 0..1 Reference(Organization) Производитель вакцины --></manufacturer>
 <lotNumber value="[string]"/><!-- 0..1 Номер партии вакцины -->
 <expirationDate value="[date]"/><!-- 0..1 Срок истечения годности вакцины -->
 <site><!-- 0..1 CodeableConcept Место на теле, куда ввели вакцину --></site>
 <route><!-- 0..1 CodeableConcept Как вакцина попала в тело --></route>
 <doseQuantity><!-- 0..1 Quantity(SimpleQuantity) Количество введенной вакцины --></doseQuantity>
 <practitioner>  <!-- 0..* Who performed event -->
  <role><!-- 0..1 CodeableConcept What type of performance was done --></role>
  <actor><!-- 1..1 Reference(Practitioner) Individual who was performing --></actor>
 </practitioner>
 <note><!-- 0..* Annotation Примечания по вакцинации --></note>
 <explanation>  <!-- 0..1 Основание для проведения или не-проведения вакцинации -->
  <reason><!-- 0..* CodeableConcept Почему произошла вакцинация --></reason>
  <reasonNotGiven><!-- 0..* CodeableConcept Почему не была проведена иммунизация --></reasonNotGiven>
 </explanation>
 <reaction>  <!-- 0..* Сведения о реакции, которая последовала за иммунизацией -->
  <date value="[dateTime]"/><!-- 0..1 Когда началась реакция -->
  <detail><!-- 0..1 Reference(Observation) Дополнительная информация по реакции --></detail>
  <reported value="[boolean]"/><!-- 0..1 Показывает, что реакция записана со слов пациента -->
 </reaction>
 <vaccinationProtocol>  <!-- 0..* Какому протоколу следовали -->
  <doseSequence value="[positiveInt]"/><!-- 0..1 Номер дозы в пределах серии -->
  <description value="[string]"/><!-- 0..1 Сведения о вакцинном протоколе -->
  <authority><!-- 0..1 Reference(Organization) Кто ответственен за протокол --></authority>
  <series value="[string]"/><!-- 0..1 Название серии вакцинаций -->
  <seriesDoses value="[positiveInt]"/><!-- 0..1 Рекомендуемое количество доз для достижения иммунитета -->
  <targetDisease><!-- 1..* CodeableConcept Заболевание, от которого проводится иммунизация --></targetDisease>
  <doseStatus><!-- 1..1 CodeableConcept Показывает, учитывает ли доза иммунитет --></doseStatus>
  <doseStatusReason><!-- 0..1 CodeableConcept Почему доза (не) рассчитывается по протоколу --></doseStatusReason>
 </vaccinationProtocol>
</Immunization>

JSON-шаблон

{doco
  "resourceType" : "Immunization",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Бизнес-идентификатор
  "status" : "<code>", // R!  completed | entered-in-error
  "notGiven" : <boolean>, // R!  Флаг, были ли проведена иммунизация
  "vaccineCode" : { CodeableConcept }, // R!  Введенная вакцина
  "patient" : { Reference(Patient) }, // R!  Кому ввели вакцину?
  "encounter" : { Reference(Encounter) }, // Случай обслуживания, в рамках которого проведена иммунизация
  "date" : "<dateTime>", // Дата вакцинации
  "primarySource" : <boolean>, // R!  Indicates context the data was recorded in
  "reportOrigin" : { CodeableConcept }, // Indicates the source of a secondarily reported record
  "location" : { Reference(Location) }, // Где происходила вакцинация
  "manufacturer" : { Reference(Organization) }, // Производитель вакцины
  "lotNumber" : "<string>", // Номер партии вакцины
  "expirationDate" : "<date>", // Срок истечения годности вакцины
  "site" : { CodeableConcept }, // Место на теле, куда ввели вакцину
  "route" : { CodeableConcept }, // Как вакцина попала в тело
  "doseQuantity" : { Quantity(SimpleQuantity) }, // Количество введенной вакцины
  "practitioner" : [{ // Who performed event
    "role" : { CodeableConcept }, // What type of performance was done
    "actor" : { Reference(Practitioner) } // R!  Individual who was performing
  }],
  "note" : [{ Annotation }], // Примечания по вакцинации
  "explanation" : { // Основание для проведения или не-проведения вакцинации
    "reason" : [{ CodeableConcept }], // Почему произошла вакцинация
    "reasonNotGiven" : [{ CodeableConcept }] // Почему не была проведена иммунизация
  },
  "reaction" : [{ // Сведения о реакции, которая последовала за иммунизацией
    "date" : "<dateTime>", // Когда началась реакция
    "detail" : { Reference(Observation) }, // Дополнительная информация по реакции
    "reported" : <boolean> // Показывает, что реакция записана со слов пациента
  }],
  "vaccinationProtocol" : [{ // Какому протоколу следовали
    "doseSequence" : "<positiveInt>", // Номер дозы в пределах серии
    "description" : "<string>", // Сведения о вакцинном протоколе
    "authority" : { Reference(Organization) }, // Кто ответственен за протокол
    "series" : "<string>", // Название серии вакцинаций
    "seriesDoses" : "<positiveInt>", // Рекомендуемое количество доз для достижения иммунитета
    "targetDisease" : [{ CodeableConcept }], // R!  Заболевание, от которого проводится иммунизация
    "doseStatus" : { CodeableConcept }, // R!  Показывает, учитывает ли доза иммунитет
    "doseStatusReason" : { CodeableConcept } // Почему доза (не) рассчитывается по протоколу
  }]
}

Turtle-шаблон

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Immunization;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Immunization.identifier [ Identifier ], ... ; # 0..* Бизнес-идентификатор
  fhir:Immunization.status [ code ]; # 1..1 completed | entered-in-error
  fhir:Immunization.notGiven [ boolean ]; # 1..1 Флаг, были ли проведена иммунизация
  fhir:Immunization.vaccineCode [ CodeableConcept ]; # 1..1 Введенная вакцина
  fhir:Immunization.patient [ Reference(Patient) ]; # 1..1 Кому ввели вакцину?
  fhir:Immunization.encounter [ Reference(Encounter) ]; # 0..1 Случай обслуживания, в рамках которого проведена иммунизация
  fhir:Immunization.date [ dateTime ]; # 0..1 Дата вакцинации
  fhir:Immunization.primarySource [ boolean ]; # 1..1 Indicates context the data was recorded in
  fhir:Immunization.reportOrigin [ CodeableConcept ]; # 0..1 Indicates the source of a secondarily reported record
  fhir:Immunization.location [ Reference(Location) ]; # 0..1 Где происходила вакцинация
  fhir:Immunization.manufacturer [ Reference(Organization) ]; # 0..1 Производитель вакцины
  fhir:Immunization.lotNumber [ string ]; # 0..1 Номер партии вакцины
  fhir:Immunization.expirationDate [ date ]; # 0..1 Срок истечения годности вакцины
  fhir:Immunization.site [ CodeableConcept ]; # 0..1 Место на теле, куда ввели вакцину
  fhir:Immunization.route [ CodeableConcept ]; # 0..1 Как вакцина попала в тело
  fhir:Immunization.doseQuantity [ Quantity(SimpleQuantity) ]; # 0..1 Количество введенной вакцины
  fhir:Immunization.practitioner [ # 0..* Who performed event
    fhir:Immunization.practitioner.role [ CodeableConcept ]; # 0..1 What type of performance was done
    fhir:Immunization.practitioner.actor [ Reference(Practitioner) ]; # 1..1 Individual who was performing
  ], ...;
  fhir:Immunization.note [ Annotation ], ... ; # 0..* Примечания по вакцинации
  fhir:Immunization.explanation [ # 0..1 Основание для проведения или не-проведения вакцинации
    fhir:Immunization.explanation.reason [ CodeableConcept ], ... ; # 0..* Почему произошла вакцинация
    fhir:Immunization.explanation.reasonNotGiven [ CodeableConcept ], ... ; # 0..* Почему не была проведена иммунизация
  ];
  fhir:Immunization.reaction [ # 0..* Сведения о реакции, которая последовала за иммунизацией
    fhir:Immunization.reaction.date [ dateTime ]; # 0..1 Когда началась реакция
    fhir:Immunization.reaction.detail [ Reference(Observation) ]; # 0..1 Дополнительная информация по реакции
    fhir:Immunization.reaction.reported [ boolean ]; # 0..1 Показывает, что реакция записана со слов пациента
  ], ...;
  fhir:Immunization.vaccinationProtocol [ # 0..* Какому протоколу следовали
    fhir:Immunization.vaccinationProtocol.doseSequence [ positiveInt ]; # 0..1 Номер дозы в пределах серии
    fhir:Immunization.vaccinationProtocol.description [ string ]; # 0..1 Сведения о вакцинном протоколе
    fhir:Immunization.vaccinationProtocol.authority [ Reference(Organization) ]; # 0..1 Кто ответственен за протокол
    fhir:Immunization.vaccinationProtocol.series [ string ]; # 0..1 Название серии вакцинаций
    fhir:Immunization.vaccinationProtocol.seriesDoses [ positiveInt ]; # 0..1 Рекомендуемое количество доз для достижения иммунитета
    fhir:Immunization.vaccinationProtocol.targetDisease [ CodeableConcept ], ... ; # 1..* Заболевание, от которого проводится иммунизация
    fhir:Immunization.vaccinationProtocol.doseStatus [ CodeableConcept ]; # 1..1 Показывает, учитывает ли доза иммунитет
    fhir:Immunization.vaccinationProtocol.doseStatusReason [ CodeableConcept ]; # 0..1 Почему доза (не) рассчитывается по протоколу
  ], ...;
]

Changes since DSTU2

Immunization
Immunization.status Change value set from http://hl7.org/fhir/ValueSet/medication-admin-status to http://hl7.org/fhir/ValueSet/immunization-status
Immunization.notGiven Renamed from wasNotGiven to notGiven
Immunization.primarySource added Element
Immunization.reportOrigin added Element
Immunization.practitioner added Element
Immunization.practitioner.role added Element
Immunization.practitioner.actor added Element
Immunization.vaccinationProtocol.doseSequence Min Cardinality changed from 1 to 0
Immunization.reported deleted
Immunization.performer deleted
Immunization.requester deleted

See the Full Difference for further information

See R2 <--> R3 Conversion Maps (status = 2 tests that all execute ok. 2 fail round-trip testing and 2 r3 resources are invalid (2 errors).).

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. Immunization IDomainResourceИнформация о событии иммунизации
+ Если иммунизация была проведена (wasNotGiven=false), тогда элемент explanation.reasonNotGiven должен отсутствовать.
+ Если иммунизация не была проведена (wasNotGiven=true), тогда элементы reaction и explanation.reason не должны присутствовать
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierБизнес-идентификатор
... status ?!Σ1..1codecompleted | entered-in-error
Immunization Status Codes (Required)
... notGiven ?!Σ1..1booleanФлаг, были ли проведена иммунизация
... vaccineCode 1..1CodeableConceptВведенная вакцина
Vaccine Administered Value Set (Example)
... patient 1..1Reference(Patient)Кому ввели вакцину?
... encounter 0..1Reference(Encounter)Случай обслуживания, в рамках которого проведена иммунизация
... date 0..1dateTimeДата вакцинации
... primarySource 1..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Immunization Origin Codes (Example)
... location 0..1Reference(Location)Где происходила вакцинация
... manufacturer 0..1Reference(Organization)Производитель вакцины
... lotNumber 0..1stringНомер партии вакцины
... expirationDate 0..1dateСрок истечения годности вакцины
... site 0..1CodeableConceptМесто на теле, куда ввели вакцину
Codes for Immunization Site of Administration (Example)
... route 0..1CodeableConceptКак вакцина попала в тело
Immunization Route Codes (Example)
... doseQuantity 0..1SimpleQuantityКоличество введенной вакцины
... practitioner Σ0..*BackboneElementWho performed event
.... role Σ0..1CodeableConceptWhat type of performance was done
Immunization Role Codes (Extensible)
.... actor Σ1..1Reference(Practitioner)Individual who was performing
... note Σ0..*AnnotationПримечания по вакцинации
... explanation 0..1BackboneElementОснование для проведения или не-проведения вакцинации
.... reason 0..*CodeableConceptПочему произошла вакцинация
Immunization Reason Codes (Example)
.... reasonNotGiven 0..*CodeableConceptПочему не была проведена иммунизация
Immunization Reasons for Not Immunizing Codes (Example)
... reaction 0..*BackboneElementСведения о реакции, которая последовала за иммунизацией
.... date 0..1dateTimeКогда началась реакция
.... detail 0..1Reference(Observation)Дополнительная информация по реакции
.... reported 0..1booleanПоказывает, что реакция записана со слов пациента
... vaccinationProtocol 0..*BackboneElementКакому протоколу следовали
.... doseSequence 0..1positiveIntНомер дозы в пределах серии
.... description 0..1stringСведения о вакцинном протоколе
.... authority 0..1Reference(Organization)Кто ответственен за протокол
.... series 0..1stringНазвание серии вакцинаций
.... seriesDoses 0..1positiveIntРекомендуемое количество доз для достижения иммунитета
.... targetDisease 1..*CodeableConceptЗаболевание, от которого проводится иммунизация
Vaccination Protocol Dose Target Codes (Example)
.... doseStatus 1..1CodeableConceptПоказывает, учитывает ли доза иммунитет
Vaccination Protocol Dose Status codes (Example)
.... doseStatusReason 0..1CodeableConceptПочему доза (не) рассчитывается по протоколу
Vaccination Protocol Dose Status Reason codes (Example)

doco Документация по этому формату

UML-диаграмма (Legend)

Immunization (DomainResource) , identifier : Identifier [0..*] (this element modifies the meaning of other elements)status : code [1..1] , (Strength=Required)Immunization Status ! , (this element modifies the meaning of other elements)notGiven : boolean [1..1], vaccineCode : CodeableConcept [1..1] (Strength=Example)Vaccine Administered Value Set?? , patient : Reference [1..1] Patient , , encounter : Reference [0..1] Encounter , date : dateTime [0..1]An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recordedprimarySource : boolean [1..1]The source of the data when the report of the immunization event is not based on information from the person who administered the vaccinereportOrigin : CodeableConcept [0..1] The source of the data for a record which is not from a primary source. (Strength=Example)Immunization Origin ?? , location : Reference [0..1] Location manufacturer : Reference [0..1] Organization lotNumber : string [0..1] expirationDate : date [0..1] , site : CodeableConcept [0..1] , (Strength=Example)Codes for Immunization Site o...?? , route : CodeableConcept [0..1] (Strength=Example)Immunization Route ?? , doseQuantity : Quantity(SimpleQuantity) [0..1] , note : Annotation [0..*]PractitionerDescribes the type of performance (e.g. ordering provider, administering provider, etc.)role : CodeableConcept [0..1] The role a practitioner plays in the immunization event (Strength=Extensible)Immunization Role + The device, practitioner, etc. who performed the actionactor : Reference [1..1] Practitioner Explanation, reason : CodeableConcept [0..*] , (Strength=Example)Immunization Reason ?? , reasonNotGiven : CodeableConcept [0..*] , (Strength=Example)Immunization Reasons for Not ...?? Reaction date : dateTime [0..1] detail : Reference [0..1] Observation , reported : boolean [0..1]VaccinationProtocol doseSequence : positiveInt [0..1] , description : string [0..1] , ? ACIPauthority : Reference [0..1] Organization - series : string [0..1] seriesDoses : positiveInt [0..1], targetDisease : CodeableConcept [1..*] , (Strength=Example)Vaccination Protocol Dose Tar...?? , doseStatus : CodeableConcept [1..1] (. . ) (Strength=Example)Vaccination Protocol Dose Sta...?? , doseStatusReason : CodeableConcept [0..1] , . (Strength=Example)Vaccination Protocol Dose Sta...?? Indicates who or what performed the eventpractitioner[0..*], explanation[0..1] , , reaction[0..*] , vaccinationProtocol[0..*]

XML-шаблон

<Immunization xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Бизнес-идентификатор --></identifier>
 <status value="[code]"/><!-- 1..1 completed | entered-in-error -->
 <notGiven value="[boolean]"/><!-- 1..1 Флаг, были ли проведена иммунизация -->
 <vaccineCode><!-- 1..1 CodeableConcept Введенная вакцина --></vaccineCode>
 <patient><!-- 1..1 Reference(Patient) Кому ввели вакцину? --></patient>
 <encounter><!-- 0..1 Reference(Encounter) Случай обслуживания, в рамках которого проведена иммунизация --></encounter>
 <date value="[dateTime]"/><!-- 0..1 Дата вакцинации -->
 <primarySource value="[boolean]"/><!-- 1..1 Indicates context the data was recorded in -->
 <reportOrigin><!-- 0..1 CodeableConcept Indicates the source of a secondarily reported record --></reportOrigin>
 <location><!-- 0..1 Reference(Location) Где происходила вакцинация --></location>
 <manufacturer><!-- 0..1 Reference(Organization) Производитель вакцины --></manufacturer>
 <lotNumber value="[string]"/><!-- 0..1 Номер партии вакцины -->
 <expirationDate value="[date]"/><!-- 0..1 Срок истечения годности вакцины -->
 <site><!-- 0..1 CodeableConcept Место на теле, куда ввели вакцину --></site>
 <route><!-- 0..1 CodeableConcept Как вакцина попала в тело --></route>
 <doseQuantity><!-- 0..1 Quantity(SimpleQuantity) Количество введенной вакцины --></doseQuantity>
 <practitioner>  <!-- 0..* Who performed event -->
  <role><!-- 0..1 CodeableConcept What type of performance was done --></role>
  <actor><!-- 1..1 Reference(Practitioner) Individual who was performing --></actor>
 </practitioner>
 <note><!-- 0..* Annotation Примечания по вакцинации --></note>
 <explanation>  <!-- 0..1 Основание для проведения или не-проведения вакцинации -->
  <reason><!-- 0..* CodeableConcept Почему произошла вакцинация --></reason>
  <reasonNotGiven><!-- 0..* CodeableConcept Почему не была проведена иммунизация --></reasonNotGiven>
 </explanation>
 <reaction>  <!-- 0..* Сведения о реакции, которая последовала за иммунизацией -->
  <date value="[dateTime]"/><!-- 0..1 Когда началась реакция -->
  <detail><!-- 0..1 Reference(Observation) Дополнительная информация по реакции --></detail>
  <reported value="[boolean]"/><!-- 0..1 Показывает, что реакция записана со слов пациента -->
 </reaction>
 <vaccinationProtocol>  <!-- 0..* Какому протоколу следовали -->
  <doseSequence value="[positiveInt]"/><!-- 0..1 Номер дозы в пределах серии -->
  <description value="[string]"/><!-- 0..1 Сведения о вакцинном протоколе -->
  <authority><!-- 0..1 Reference(Organization) Кто ответственен за протокол --></authority>
  <series value="[string]"/><!-- 0..1 Название серии вакцинаций -->
  <seriesDoses value="[positiveInt]"/><!-- 0..1 Рекомендуемое количество доз для достижения иммунитета -->
  <targetDisease><!-- 1..* CodeableConcept Заболевание, от которого проводится иммунизация --></targetDisease>
  <doseStatus><!-- 1..1 CodeableConcept Показывает, учитывает ли доза иммунитет --></doseStatus>
  <doseStatusReason><!-- 0..1 CodeableConcept Почему доза (не) рассчитывается по протоколу --></doseStatusReason>
 </vaccinationProtocol>
</Immunization>

JSON-шаблон

{doco
  "resourceType" : "Immunization",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Бизнес-идентификатор
  "status" : "<code>", // R!  completed | entered-in-error
  "notGiven" : <boolean>, // R!  Флаг, были ли проведена иммунизация
  "vaccineCode" : { CodeableConcept }, // R!  Введенная вакцина
  "patient" : { Reference(Patient) }, // R!  Кому ввели вакцину?
  "encounter" : { Reference(Encounter) }, // Случай обслуживания, в рамках которого проведена иммунизация
  "date" : "<dateTime>", // Дата вакцинации
  "primarySource" : <boolean>, // R!  Indicates context the data was recorded in
  "reportOrigin" : { CodeableConcept }, // Indicates the source of a secondarily reported record
  "location" : { Reference(Location) }, // Где происходила вакцинация
  "manufacturer" : { Reference(Organization) }, // Производитель вакцины
  "lotNumber" : "<string>", // Номер партии вакцины
  "expirationDate" : "<date>", // Срок истечения годности вакцины
  "site" : { CodeableConcept }, // Место на теле, куда ввели вакцину
  "route" : { CodeableConcept }, // Как вакцина попала в тело
  "doseQuantity" : { Quantity(SimpleQuantity) }, // Количество введенной вакцины
  "practitioner" : [{ // Who performed event
    "role" : { CodeableConcept }, // What type of performance was done
    "actor" : { Reference(Practitioner) } // R!  Individual who was performing
  }],
  "note" : [{ Annotation }], // Примечания по вакцинации
  "explanation" : { // Основание для проведения или не-проведения вакцинации
    "reason" : [{ CodeableConcept }], // Почему произошла вакцинация
    "reasonNotGiven" : [{ CodeableConcept }] // Почему не была проведена иммунизация
  },
  "reaction" : [{ // Сведения о реакции, которая последовала за иммунизацией
    "date" : "<dateTime>", // Когда началась реакция
    "detail" : { Reference(Observation) }, // Дополнительная информация по реакции
    "reported" : <boolean> // Показывает, что реакция записана со слов пациента
  }],
  "vaccinationProtocol" : [{ // Какому протоколу следовали
    "doseSequence" : "<positiveInt>", // Номер дозы в пределах серии
    "description" : "<string>", // Сведения о вакцинном протоколе
    "authority" : { Reference(Organization) }, // Кто ответственен за протокол
    "series" : "<string>", // Название серии вакцинаций
    "seriesDoses" : "<positiveInt>", // Рекомендуемое количество доз для достижения иммунитета
    "targetDisease" : [{ CodeableConcept }], // R!  Заболевание, от которого проводится иммунизация
    "doseStatus" : { CodeableConcept }, // R!  Показывает, учитывает ли доза иммунитет
    "doseStatusReason" : { CodeableConcept } // Почему доза (не) рассчитывается по протоколу
  }]
}

Turtle-шаблон

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Immunization;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Immunization.identifier [ Identifier ], ... ; # 0..* Бизнес-идентификатор
  fhir:Immunization.status [ code ]; # 1..1 completed | entered-in-error
  fhir:Immunization.notGiven [ boolean ]; # 1..1 Флаг, были ли проведена иммунизация
  fhir:Immunization.vaccineCode [ CodeableConcept ]; # 1..1 Введенная вакцина
  fhir:Immunization.patient [ Reference(Patient) ]; # 1..1 Кому ввели вакцину?
  fhir:Immunization.encounter [ Reference(Encounter) ]; # 0..1 Случай обслуживания, в рамках которого проведена иммунизация
  fhir:Immunization.date [ dateTime ]; # 0..1 Дата вакцинации
  fhir:Immunization.primarySource [ boolean ]; # 1..1 Indicates context the data was recorded in
  fhir:Immunization.reportOrigin [ CodeableConcept ]; # 0..1 Indicates the source of a secondarily reported record
  fhir:Immunization.location [ Reference(Location) ]; # 0..1 Где происходила вакцинация
  fhir:Immunization.manufacturer [ Reference(Organization) ]; # 0..1 Производитель вакцины
  fhir:Immunization.lotNumber [ string ]; # 0..1 Номер партии вакцины
  fhir:Immunization.expirationDate [ date ]; # 0..1 Срок истечения годности вакцины
  fhir:Immunization.site [ CodeableConcept ]; # 0..1 Место на теле, куда ввели вакцину
  fhir:Immunization.route [ CodeableConcept ]; # 0..1 Как вакцина попала в тело
  fhir:Immunization.doseQuantity [ Quantity(SimpleQuantity) ]; # 0..1 Количество введенной вакцины
  fhir:Immunization.practitioner [ # 0..* Who performed event
    fhir:Immunization.practitioner.role [ CodeableConcept ]; # 0..1 What type of performance was done
    fhir:Immunization.practitioner.actor [ Reference(Practitioner) ]; # 1..1 Individual who was performing
  ], ...;
  fhir:Immunization.note [ Annotation ], ... ; # 0..* Примечания по вакцинации
  fhir:Immunization.explanation [ # 0..1 Основание для проведения или не-проведения вакцинации
    fhir:Immunization.explanation.reason [ CodeableConcept ], ... ; # 0..* Почему произошла вакцинация
    fhir:Immunization.explanation.reasonNotGiven [ CodeableConcept ], ... ; # 0..* Почему не была проведена иммунизация
  ];
  fhir:Immunization.reaction [ # 0..* Сведения о реакции, которая последовала за иммунизацией
    fhir:Immunization.reaction.date [ dateTime ]; # 0..1 Когда началась реакция
    fhir:Immunization.reaction.detail [ Reference(Observation) ]; # 0..1 Дополнительная информация по реакции
    fhir:Immunization.reaction.reported [ boolean ]; # 0..1 Показывает, что реакция записана со слов пациента
  ], ...;
  fhir:Immunization.vaccinationProtocol [ # 0..* Какому протоколу следовали
    fhir:Immunization.vaccinationProtocol.doseSequence [ positiveInt ]; # 0..1 Номер дозы в пределах серии
    fhir:Immunization.vaccinationProtocol.description [ string ]; # 0..1 Сведения о вакцинном протоколе
    fhir:Immunization.vaccinationProtocol.authority [ Reference(Organization) ]; # 0..1 Кто ответственен за протокол
    fhir:Immunization.vaccinationProtocol.series [ string ]; # 0..1 Название серии вакцинаций
    fhir:Immunization.vaccinationProtocol.seriesDoses [ positiveInt ]; # 0..1 Рекомендуемое количество доз для достижения иммунитета
    fhir:Immunization.vaccinationProtocol.targetDisease [ CodeableConcept ], ... ; # 1..* Заболевание, от которого проводится иммунизация
    fhir:Immunization.vaccinationProtocol.doseStatus [ CodeableConcept ]; # 1..1 Показывает, учитывает ли доза иммунитет
    fhir:Immunization.vaccinationProtocol.doseStatusReason [ CodeableConcept ]; # 0..1 Почему доза (не) рассчитывается по протоколу
  ], ...;
]

Changes since DSTU2

Immunization
Immunization.status Change value set from http://hl7.org/fhir/ValueSet/medication-admin-status to http://hl7.org/fhir/ValueSet/immunization-status
Immunization.notGiven Renamed from wasNotGiven to notGiven
Immunization.primarySource added Element
Immunization.reportOrigin added Element
Immunization.practitioner added Element
Immunization.practitioner.role added Element
Immunization.practitioner.actor added Element
Immunization.vaccinationProtocol.doseSequence Min Cardinality changed from 1 to 0
Immunization.reported deleted
Immunization.performer deleted
Immunization.requester deleted

See the Full Difference for further information

See R2 <--> R3 Conversion Maps (status = 2 tests that all execute ok. 2 fail round-trip testing and 2 r3 resources are invalid (2 errors).).

 

Альтернативные определения: Основное определение (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

ПутьОписаниеТипСсылка
Immunization.status Ряд кодов, показывающих текущий статус иммунизацииRequiredImmunization Status Codes
Immunization.vaccineCode Код введённого препарата вакциныExampleVaccine Administered Value Set
Immunization.reportOrigin The source of the data for a record which is not from a primary source.ExampleImmunization Origin Codes
Immunization.site Место, куда вводилась вакцинаExampleCodes for Immunization Site of Administration
Immunization.route Метод введения вакциныExampleImmunization Route Codes
Immunization.practitioner.role The role a practitioner plays in the immunization eventExtensibleImmunization Role Codes
Immunization.explanation.reason Причина, почему вакцина была введенаExampleImmunization Reason Codes
Immunization.explanation.reasonNotGiven Причина, почему вакцина не была введенаExampleImmunization Reasons for Not Immunizing Codes
Immunization.vaccinationProtocol.targetDisease Заболевание, к которому относится протокол вакцинацииExampleVaccination Protocol Dose Target Codes
Immunization.vaccinationProtocol.doseStatus Статус протокола вакцинации (т. е. должен ли он учитываться)ExampleVaccination Protocol Dose Status codes
Immunization.vaccinationProtocol.doseStatusReason Обоснование решения, должна ли вакцинация рассчитываться по протоколу или нет.ExampleVaccination Protocol Dose Status Reason codes

  • imm-1: Если иммунизация не была проведена (wasNotGiven=true), тогда элементы reaction и explanation.reason не должны присутствовать (expression : (notGiven = true).not() or (reaction.empty() and explanation.reason.empty()))
  • imm-2: Если иммунизация была проведена (wasNotGiven=false), тогда элемент explanation.reasonNotGiven должен отсутствовать. (expression : (notGiven = true) or explanation.reasonNotGiven.empty())

Параметры поиска для этого ресурса. Также к нему применяются общие параметры. Более подробную информацию о поиске в REST, обмене сообщениями и сервисах см. в разделе Поиск.

ИмяТипОписаниеВыражениеIn Common
datedateДата введения (или невведения) вакцинацииImmunization.date18 Resources
dose-sequencenumberНомер дозы в пределах серииImmunization.vaccinationProtocol.doseSequence
identifiertokenБизнес-идентификаторImmunization.identifier26 Resources
locationreferenceМесто оказания услуги или учреждение, в котором вводилась или будет вводиться вакцинаImmunization.location
(Location)
lot-numberstringНомер партии вакциныImmunization.lotNumber
manufacturerreferenceПроизводитель вакциныImmunization.manufacturer
(Organization)
notgiventokenНепроведённые вакцинацииImmunization.notGiven
patientreferenceПациент, для которого записывается вакцинацияImmunization.patient
(Patient)
31 Resources
practitionerreferenceThe practitioner who played a role in the vaccinationImmunization.practitioner.actor
(Practitioner)
reactionreferenceДополнительная информация по реакцииImmunization.reaction.detail
(Observation)
reaction-datedateКогда началась реакцияImmunization.reaction.date
reasontokenПочему произошла вакцинацияImmunization.explanation.reason
reason-not-giventokenОбъяснение причины, по которой вакцинация не была проведенаImmunization.explanation.reasonNotGiven
statustokenСтатус события иммунизацииImmunization.status
vaccine-codetokenВведённый препарат вакциныImmunization.vaccineCode