Current Build

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

8.17 Ресурс Substance - Назначение

Orders and Observations Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Однородное вещество с определённым составом.

This resource allows for a material to be represented. The resource can be used to represent either a kind of a substance - e.g. a formulation commonly used for treating patients, or it can be used to describe a particular package of a known substance (e.g. bottle, jar, packet).

The composition of the material can be specified in terms of a mix of other materials, including with precise amounts if required.

A medication is a substance that is packaged and used as an administered medication. The medication resource uses the substance resource to represent the actual ingredients of a medication.

На этот ресурс ссылаются ActivityDefinition, AdverseEvent, BiologicallyDerivedProduct, CarePlan, ChargeItem, ChargeItemDefinition, Contract, Group, Medication, MedicationKnowledge, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductInteraction, Procedure, Specimen, SpecimenDefinition, itself, SubstanceSpecification, SupplyDelivery и SupplyRequest

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. Substance TUDomainResourceОднородное вещество с определённым составом
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierУникальный идентификатор
... status ?!Σ0..1codeactive | inactive | entered-in-error
FHIRSubstanceStatus (Required)
... category Σ0..*CodeableConceptЧто это за класс/тип вещества
Substance Category Codes (Extensible)
... code Σ1..1CodeableConceptЧто это за вещество
Substance Code (Example)
... description Σ0..1stringТекстовое описание вещества, комментарии
... instance Σ0..*BackboneElementЕсли это описание определенной упаковки/контейнера вещества
.... identifier Σ0..1IdentifierИдентификатор упаковки/контейнера
.... expiry Σ0..1dateTimeКогда больше не предназначен для использования
.... quantity Σ0..1SimpleQuantityКоличество вещества в упаковке
... ingredient Σ0..*BackboneElementИнформация о составе вещества
.... quantity Σ0..1RatioНеобязательное указание количества (концентрации)
.... substance[x] Σ1..1Компонент вещества
Substance Code (Example)
..... substanceCodeableConceptCodeableConcept
..... substanceReferenceReference(Substance)

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

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

Substance (DomainResource)Уникальный идентификатор веществаidentifier : Identifier [0..*]A code to indicate if the substance is actively used (this element modifies the meaning of other elements)status : code [0..1] « A code to indicate if the substance is actively used. (Strength=Required)FHIRSubstanceStatus! »A code that classifies the general type of substance. This is used for searching, sorting and display purposescategory : CodeableConcept [0..*] « Категория или классификация вещества. (Strength=Extensible)SubstanceCategoryCodes+ »Код (или набор кодов), определяющий это веществоcode : CodeableConcept [1..1] « Коды вещества. (Strength=Example)SubstanceCode?? »Описание вещества - внешний вид, требования по обращению с ним и другие полезные примечания к использованиюdescription : string [0..1]InstanceИдентификатор, ассоциированный с этой упаковкой/контейнером (обычно метка, добавленная непосредственно на него)identifier : Identifier [0..1]Дата истечения срока годности вещества. Для указания срока годности некоторых веществ используется одна произвольная датаexpiry : dateTime [0..1]Количество веществаquantity : Quantity(SimpleQuantity) [0..1]IngredientКоличество ингредиента в веществе - коэффициент концентрацииquantity : Ratio [0..1]Другое вещество, являющееся компонентом данного веществаsubstance[x] : Type [1..1] « CodeableConcept|Reference(Substance); Substance Ingredient codes. (Strength=Example) SubstanceCode?? »Ресурс Substance можно использовать для описания вида вещества или конкретной упаковки/контейнера вещества: экземплярinstance[0..*]Вещество может состоять из других веществingredient[0..*]

XML-шаблон

<Substance 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]"/><!-- 0..1 active | inactive | entered-in-error -->
 <category><!-- 0..* CodeableConcept Что это за класс/тип вещества --></category>
 <code><!-- 1..1 CodeableConcept Что это за вещество --></code>
 <description value="[string]"/><!-- 0..1 Текстовое описание вещества, комментарии -->
 <instance>  <!-- 0..* Если это описание определенной упаковки/контейнера вещества -->
  <identifier><!-- 0..1 Identifier Идентификатор упаковки/контейнера --></identifier>
  <expiry value="[dateTime]"/><!-- 0..1 Когда больше не предназначен для использования -->
  <quantity><!-- 0..1 Quantity(SimpleQuantity) Количество вещества в упаковке --></quantity>
 </instance>
 <ingredient>  <!-- 0..* Информация о составе вещества -->
  <quantity><!-- 0..1 Ratio Необязательное указание количества (концентрации) --></quantity>
  <substance[x]><!-- 1..1 CodeableConcept|Reference(Substance) Компонент вещества --></substance[x]>
 </ingredient>
</Substance>

Turtle-шаблон

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


[ a fhir:Substance;
  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:Substance.identifier [ Identifier ], ... ; # 0..* Уникальный идентификатор
  fhir:Substance.status [ code ]; # 0..1 active | inactive | entered-in-error
  fhir:Substance.category [ CodeableConcept ], ... ; # 0..* Что это за класс/тип вещества
  fhir:Substance.code [ CodeableConcept ]; # 1..1 Что это за вещество
  fhir:Substance.description [ string ]; # 0..1 Текстовое описание вещества, комментарии
  fhir:Substance.instance [ # 0..* Если это описание определенной упаковки/контейнера вещества
    fhir:Substance.instance.identifier [ Identifier ]; # 0..1 Идентификатор упаковки/контейнера
    fhir:Substance.instance.expiry [ dateTime ]; # 0..1 Когда больше не предназначен для использования
    fhir:Substance.instance.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Количество вещества в упаковке
  ], ...;
  fhir:Substance.ingredient [ # 0..* Информация о составе вещества
    fhir:Substance.ingredient.quantity [ Ratio ]; # 0..1 Необязательное указание количества (концентрации)
    # Substance.ingredient.substance[x] : 1..1 Компонент вещества. One of these 2
      fhir:Substance.ingredient.substanceCodeableConcept [ CodeableConcept ]
      fhir:Substance.ingredient.substanceReference [ Reference(Substance) ]
  ], ...;
]

Changes since R3

Substance
Substance.status
  • Now marked as Modifier
Substance.category
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/substance-category" to "http://terminology.hl7.org/CodeSystem/substance-category"

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 6 tests that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors).)

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. Substance TUDomainResourceОднородное вещество с определённым составом
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierУникальный идентификатор
... status ?!Σ0..1codeactive | inactive | entered-in-error
FHIRSubstanceStatus (Required)
... category Σ0..*CodeableConceptЧто это за класс/тип вещества
Substance Category Codes (Extensible)
... code Σ1..1CodeableConceptЧто это за вещество
Substance Code (Example)
... description Σ0..1stringТекстовое описание вещества, комментарии
... instance Σ0..*BackboneElementЕсли это описание определенной упаковки/контейнера вещества
.... identifier Σ0..1IdentifierИдентификатор упаковки/контейнера
.... expiry Σ0..1dateTimeКогда больше не предназначен для использования
.... quantity Σ0..1SimpleQuantityКоличество вещества в упаковке
... ingredient Σ0..*BackboneElementИнформация о составе вещества
.... quantity Σ0..1RatioНеобязательное указание количества (концентрации)
.... substance[x] Σ1..1Компонент вещества
Substance Code (Example)
..... substanceCodeableConceptCodeableConcept
..... substanceReferenceReference(Substance)

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

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

Substance (DomainResource)Уникальный идентификатор веществаidentifier : Identifier [0..*]A code to indicate if the substance is actively used (this element modifies the meaning of other elements)status : code [0..1] « A code to indicate if the substance is actively used. (Strength=Required)FHIRSubstanceStatus! »A code that classifies the general type of substance. This is used for searching, sorting and display purposescategory : CodeableConcept [0..*] « Категория или классификация вещества. (Strength=Extensible)SubstanceCategoryCodes+ »Код (или набор кодов), определяющий это веществоcode : CodeableConcept [1..1] « Коды вещества. (Strength=Example)SubstanceCode?? »Описание вещества - внешний вид, требования по обращению с ним и другие полезные примечания к использованиюdescription : string [0..1]InstanceИдентификатор, ассоциированный с этой упаковкой/контейнером (обычно метка, добавленная непосредственно на него)identifier : Identifier [0..1]Дата истечения срока годности вещества. Для указания срока годности некоторых веществ используется одна произвольная датаexpiry : dateTime [0..1]Количество веществаquantity : Quantity(SimpleQuantity) [0..1]IngredientКоличество ингредиента в веществе - коэффициент концентрацииquantity : Ratio [0..1]Другое вещество, являющееся компонентом данного веществаsubstance[x] : Type [1..1] « CodeableConcept|Reference(Substance); Substance Ingredient codes. (Strength=Example) SubstanceCode?? »Ресурс Substance можно использовать для описания вида вещества или конкретной упаковки/контейнера вещества: экземплярinstance[0..*]Вещество может состоять из других веществingredient[0..*]

XML-шаблон

<Substance 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]"/><!-- 0..1 active | inactive | entered-in-error -->
 <category><!-- 0..* CodeableConcept Что это за класс/тип вещества --></category>
 <code><!-- 1..1 CodeableConcept Что это за вещество --></code>
 <description value="[string]"/><!-- 0..1 Текстовое описание вещества, комментарии -->
 <instance>  <!-- 0..* Если это описание определенной упаковки/контейнера вещества -->
  <identifier><!-- 0..1 Identifier Идентификатор упаковки/контейнера --></identifier>
  <expiry value="[dateTime]"/><!-- 0..1 Когда больше не предназначен для использования -->
  <quantity><!-- 0..1 Quantity(SimpleQuantity) Количество вещества в упаковке --></quantity>
 </instance>
 <ingredient>  <!-- 0..* Информация о составе вещества -->
  <quantity><!-- 0..1 Ratio Необязательное указание количества (концентрации) --></quantity>
  <substance[x]><!-- 1..1 CodeableConcept|Reference(Substance) Компонент вещества --></substance[x]>
 </ingredient>
</Substance>

Turtle-шаблон

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


[ a fhir:Substance;
  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:Substance.identifier [ Identifier ], ... ; # 0..* Уникальный идентификатор
  fhir:Substance.status [ code ]; # 0..1 active | inactive | entered-in-error
  fhir:Substance.category [ CodeableConcept ], ... ; # 0..* Что это за класс/тип вещества
  fhir:Substance.code [ CodeableConcept ]; # 1..1 Что это за вещество
  fhir:Substance.description [ string ]; # 0..1 Текстовое описание вещества, комментарии
  fhir:Substance.instance [ # 0..* Если это описание определенной упаковки/контейнера вещества
    fhir:Substance.instance.identifier [ Identifier ]; # 0..1 Идентификатор упаковки/контейнера
    fhir:Substance.instance.expiry [ dateTime ]; # 0..1 Когда больше не предназначен для использования
    fhir:Substance.instance.quantity [ Quantity(SimpleQuantity) ]; # 0..1 Количество вещества в упаковке
  ], ...;
  fhir:Substance.ingredient [ # 0..* Информация о составе вещества
    fhir:Substance.ingredient.quantity [ Ratio ]; # 0..1 Необязательное указание количества (концентрации)
    # Substance.ingredient.substance[x] : 1..1 Компонент вещества. One of these 2
      fhir:Substance.ingredient.substanceCodeableConcept [ CodeableConcept ]
      fhir:Substance.ingredient.substanceReference [ Reference(Substance) ]
  ], ...;
]

Changes since Release 3

Substance
Substance.status
  • Now marked as Modifier
Substance.category
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/substance-category" to "http://terminology.hl7.org/CodeSystem/substance-category"

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 6 tests that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors).)

 

See the Profiles & Extensions and the Альтернативные определения: Основное определение XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the Анализ зависимостей

PathОписаниеТипСсылка
Substance.status A code to indicate if the substance is actively used.RequiredFHIRSubstanceStatus
Substance.category Категория или классификация вещества.ExtensibleSubstanceCategoryCodes
Substance.code Коды вещества.ExampleSubstanceCode
Substance.ingredient.substance[x] Substance Ingredient codes.ExampleSubstanceCode

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

ИмяТипОпределениеВыражениеIn Common
categorytokenКатегория веществаSubstance.category
codetokenThe code of the substance or ingredientSubstance.code | (Substance.ingredient.substance as CodeableConcept)
container-identifiertokenИдентификатор упаковки/контейнераSubstance.instance.identifier
expirydateСрок годности упаковки или контейнера веществаSubstance.instance.expiry
identifiertokenУникальный идентификатор веществаSubstance.identifier
quantityquantityКоличество вещества в упаковкеSubstance.instance.quantity
statustokenactive | inactive | entered-in-errorSubstance.status
substance-referencereferenceКомпонент вещества(Substance.ingredient.substance as Reference)
(Substance)