Current Build

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

5.8 Ресурс ImplementationGuide - Назначение

FHIR Infrastructure Work GroupMaturity Level: 1 Trial UseCompartments: Not linked to any defined compartments

Набор правил о том, как используется FHIR для решения конкретной задачи. Этот ресурс используется для сбора всех составляющих руководства по реализации в единое логическое целое, а также для публикации вычислимого определения всех этих частей.

An implementation guide (IG) is a set of rules about how FHIR resources are used (or should be used) to solve a particular problem, with associated documentation to support and clarify the usage. Classically, FHIR implementation guides are published on the web after they are generated using the FHIR Implementation Guide Publisher .

The ImplementationGuide resource is a single resource that defines the logical content of the IG, along with the important entry pages into the publication, so that the logical package that the IG represents, so that the contents are computable.

In particular, validators are able to use the ImplementationGuide resource to validate content against the implementation guide as a whole. The significant conformance expectation introduced by the ImplementationGuide resource is the idea of Default Profiles. Implementations may conform to multiple implementation guides at once, but this requires that the implementation guides are compatible (see below).

Руководства по реализации содержат два различных типа ссылок на ресурсы:

  • Содержимое: набор логических утверждений, которые должны выполняться реализациями. Это почти всегда ресурсы обеспечения соответствия
  • Примеры: примеры, иллюстрирующие назначение профилей, заданных в руководстве по реализации. Это могут быть любые виды ресурсов

Заявление о возможностях может указывать на одно или несколько руководств по реализации, которым соответствует приложение.

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. ImplementationGuide DomainResourceНабор правил о том, как используется FHIR
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ1..1uriLogical URI to reference this implementation guide (globally unique)
... version Σ0..1stringBusiness version of the implementation guide
... name Σ1..1stringName for this implementation guide (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the implementation guide
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for implementation guide (if applicable)
Jurisdiction ValueSet (Extensible)
... copyright 0..1markdownUse and/or publishing restrictions
... fhirVersion Σ0..1idВерсия FHIR, которой соответствует это руководство по реализации
... dependency Σ0..*BackboneElementДругое руководство по реализации, от которого зависит данное
.... type Σ1..1codereference | inclusion
GuideDependencyType (Required)
.... uri Σ1..1uriГде найти зависимость
... package Σ0..*BackboneElementГруппа ресурсов, использованных в .page.package
.... name Σ1..1stringИмя, используемое в .page.package
.... description 0..1stringЧеловекочитаемый текст, описывающий этот пакет
.... resource Σ1..*BackboneElementРесурс в руководстве по реализации
..... example Σ1..1booleanЕсли это не пример, то имеет своё обычное смысловое значение
..... name Σ0..1stringНазначенное человеком имя ресурса
..... description 0..1stringПричина включения в руководство
..... acronym 0..1stringКороткий код для идентификации ресурса
..... source[x] Σ1..1Местонахождение ресурса
...... sourceUriuri
...... sourceReferenceReference(Any)
..... exampleFor 0..1Reference(StructureDefinition)Ресурс, для которого приводится этот пример (если применимо)
... global Σ0..*BackboneElementПрофили, применяемые глобально
.... type Σ1..1codeТип ресурса, к которому применяется этот профиль
ResourceType (Required)
.... profile Σ1..1Reference(StructureDefinition)Профиль, которому должны соответствовать все ресурсы
... binary 0..*uriИзображение, каскадная таблица стилей, скрипт и т. п
... page Σ0..1BackboneElementСтраница/раздел руководства
.... source Σ1..1uriГде найти эту страницу
.... title Σ1..1stringShort title shown for navigational assistance
.... kind Σ1..1codepage | example | list | include | directory | dictionary | toc | resource
GuidePageKind (Required)
.... type 0..*codeKind of resource to include in the list
ResourceType (Required)
.... package 0..*stringName of package to include
.... format 0..1codeФормат страницы (например html, markdown, др.)
MimeType (Required)
.... page 0..*see pageВложенные страницы/разделы

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

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

ImplementationGuide (DomainResource)An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](resource.html#versions)url : uri [1..1]The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [1..1]The status of this implementation guide. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! »A boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the implementation guide was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changesdate : dateTime [0..1]The name of the individual or organization that published the implementation guidepublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the implementation guide from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate implementation guide instancesuseContext : UsageContext [0..*]A legal or geographic region in which the implementation guide is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ »A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guidecopyright : markdown [0..1]The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.1.0 for this versionfhirVersion : id [0..1]Бинарный файл, включаемый в руководство по реализации при публикацииbinary : uri [0..*]DependencyТип зависимости после публикации руководстваtype : code [1..1] « Как зависимость будет представлена, когда руководство будет опубликовано. (Strength=Required)GuideDependencyType! »Где расположена эта зависимостьuri : uri [1..1]PackageИмя группы, используемое в page.packagename : string [1..1]Человекочитаемый текст, описывающий этот пакетdescription : string [0..1]ResourceВключён ли ресурс в руководство в составе правил, задаваемых руководством, или это просто пример ресурса, который соответствует этим правилам и/или помогает реализаторам понять назначение этого руководстваexample : boolean [1..1]Назначенное человеком имя ресурса. Все ресурсы должны иметь имя, однако это имя может извлекаться из ресурса (например ValueSet.name)name : string [0..1]Описание причины, по которой ресурс был включён в руководство по реализацииdescription : string [0..1]Короткий код, который можно использовать для идентификации ресурса в руководстве по реализацииacronym : string [0..1]Где находится этот ресурсsource[x] : Type [1..1] « uri|Reference(Any) »Другой ресурс, примером которого является данный ресурс. По большей части используется для ресурсов, включённых в качестве примеров ресурсов StructureDefinitionexampleFor : Reference [0..1] « StructureDefinition »GlobalТип ресурса, все экземпляры которого должны соответствовать профилюtype : code [1..1] « One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! »Ссылка на профиль, которому должны соответствовать все экземпляры [ресурса]profile : Reference [1..1] « StructureDefinition »PageАдрес источника для этой страницыsource : uri [1..1]A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etctitle : string [1..1]Тип страницы. Некоторые страницы генерируются автоматически (list, example), другие типы нужны для навигации пользователя к странице, представляющей интересkind : code [1..1] « Тип включённой страницы. (Strength=Required)GuidePageKind! »For constructed pages, what kind of resources to include in the listtype : code [0..*] « One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! »For constructed pages, a list of packages to include in the page (or else empty for everything)package : string [0..*]Формат страницыformat : code [0..1] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)MimeType! »Другое руководство по реализации, от которого зависит данное. Обычно в руководстве по реализации используются наборы значений, профили и др., определённые в других руководствах по реализацииdependency[0..*]Ресурс, являющийся частью руководства по реализации. Очевидными кандидатами для включения в руководство являются ресурсы обеспечения соответствия (набор значений, структурное определение, заявления о соответствии и др.), однако для включения в качестве примера разрешены все виды ресурсовresource[1..*]Логическая группа ресурсов. Логические группы используются при построении страницpackage[0..*]Ряд профилей, которым должны соответствовать все ресурсы, охватываемые данным руководством по реализацииglobal[0..*]Вложенные страницы/разделы для этой страницыpage[0..*]Страница/раздел в руководстве по реализации. Корневой страницей является главная ("домашняя") страница руководства по реализацииpage[0..1]

XML-шаблон

<ImplementationGuide xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 1..1 Logical URI to reference this implementation guide (globally unique) -->
 <version value="[string]"/><!-- 0..1 Business version of the implementation guide -->
 <name value="[string]"/><!-- 1..1 Name for this implementation guide (computer friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the implementation guide -->
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for implementation guide (if applicable) --></jurisdiction>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <fhirVersion value="[id]"/><!-- 0..1 Версия FHIR, которой соответствует это руководство по реализации -->
 <dependency>  <!-- 0..* Другое руководство по реализации, от которого зависит данное -->
  <type value="[code]"/><!-- 1..1 reference | inclusion -->
  <uri value="[uri]"/><!-- 1..1 Где найти зависимость -->
 </dependency>
 <package>  <!-- 0..* Группа ресурсов, использованных в .page.package -->
  <name value="[string]"/><!-- 1..1 Имя, используемое в .page.package -->
  <description value="[string]"/><!-- 0..1 Человекочитаемый текст, описывающий этот пакет -->
  <resource>  <!-- 1..* Ресурс в руководстве по реализации -->
   <example value="[boolean]"/><!-- 1..1 Если это не пример, то имеет своё обычное смысловое значение -->
   <name value="[string]"/><!-- 0..1 Назначенное человеком имя ресурса -->
   <description value="[string]"/><!-- 0..1 Причина включения в руководство -->
   <acronym value="[string]"/><!-- 0..1 Короткий код для идентификации ресурса -->
   <source[x]><!-- 1..1 uri|Reference(Any) Местонахождение ресурса --></source[x]>
   <exampleFor><!-- 0..1 Reference(StructureDefinition) Ресурс, для которого приводится этот пример (если применимо) --></exampleFor>
  </resource>
 </package>
 <global>  <!-- 0..* Профили, применяемые глобально -->
  <type value="[code]"/><!-- 1..1 Тип ресурса, к которому применяется этот профиль -->
  <profile><!-- 1..1 Reference(StructureDefinition) Профиль, которому должны соответствовать все ресурсы --></profile>
 </global>
 <binary value="[uri]"/><!-- 0..* Изображение, каскадная таблица стилей, скрипт и т. п -->
 <page>  <!-- 0..1 Страница/раздел руководства -->
  <source value="[uri]"/><!-- 1..1 Где найти эту страницу -->
  <title value="[string]"/><!-- 1..1 Short title shown for navigational assistance -->
  <kind value="[code]"/><!-- 1..1 page | example | list | include | directory | dictionary | toc | resource -->
  <type value="[code]"/><!-- 0..* Kind of resource to include in the list -->
  <package value="[string]"/><!-- 0..* Name of package to include -->
  <format value="[code]"/><!-- 0..1 Формат страницы (например html, markdown, др.)  -->
  <page><!-- 0..* Content as for ImplementationGuide.page Вложенные страницы/разделы --></page>
 </page>
</ImplementationGuide>

JSON-шаблон

{doco
  "resourceType" : "ImplementationGuide",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Logical URI to reference this implementation guide (globally unique)
  "version" : "<string>", // Business version of the implementation guide
  "name" : "<string>", // R!  Name for this implementation guide (computer friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the implementation guide
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for implementation guide (if applicable)
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "fhirVersion" : "<id>", // Версия FHIR, которой соответствует это руководство по реализации
  "dependency" : [{ // Другое руководство по реализации, от которого зависит данное
    "type" : "<code>", // R!  reference | inclusion
    "uri" : "<uri>" // R!  Где найти зависимость
  }],
  "package" : [{ // Группа ресурсов, использованных в .page.package
    "name" : "<string>", // R!  Имя, используемое в .page.package
    "description" : "<string>", // Человекочитаемый текст, описывающий этот пакет
    "resource" : [{ // R!  Ресурс в руководстве по реализации
      "example" : <boolean>, // R!  Если это не пример, то имеет своё обычное смысловое значение
      "name" : "<string>", // Назначенное человеком имя ресурса
      "description" : "<string>", // Причина включения в руководство
      "acronym" : "<string>", // Короткий код для идентификации ресурса
      // source[x]: Местонахождение ресурса. One of these 2:
      "sourceUri" : "<uri>",
      "sourceReference" : { Reference(Any) },
      "exampleFor" : { Reference(StructureDefinition) } // Ресурс, для которого приводится этот пример (если применимо)
    }]
  }],
  "global" : [{ // Профили, применяемые глобально
    "type" : "<code>", // R!  Тип ресурса, к которому применяется этот профиль
    "profile" : { Reference(StructureDefinition) } // R!  Профиль, которому должны соответствовать все ресурсы
  }],
  "binary" : ["<uri>"], // Изображение, каскадная таблица стилей, скрипт и т. п
  "page" : { // Страница/раздел руководства
    "source" : "<uri>", // R!  Где найти эту страницу
    "title" : "<string>", // R!  Short title shown for navigational assistance
    "kind" : "<code>", // R!  page | example | list | include | directory | dictionary | toc | resource
    "type" : ["<code>"], // Kind of resource to include in the list
    "package" : ["<string>"], // Name of package to include
    "format" : "<code>", // Формат страницы (например html, markdown, др.) 
    "page" : [{ Content as for ImplementationGuide.page }] // Вложенные страницы/разделы
  }
}

Turtle-шаблон

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


[ a fhir:ImplementationGuide;
  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:ImplementationGuide.url [ uri ]; # 1..1 Logical URI to reference this implementation guide (globally unique)
  fhir:ImplementationGuide.version [ string ]; # 0..1 Business version of the implementation guide
  fhir:ImplementationGuide.name [ string ]; # 1..1 Name for this implementation guide (computer friendly)
  fhir:ImplementationGuide.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ImplementationGuide.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ImplementationGuide.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:ImplementationGuide.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ImplementationGuide.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ImplementationGuide.description [ markdown ]; # 0..1 Natural language description of the implementation guide
  fhir:ImplementationGuide.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:ImplementationGuide.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for implementation guide (if applicable)
  fhir:ImplementationGuide.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ImplementationGuide.fhirVersion [ id ]; # 0..1 Версия FHIR, которой соответствует это руководство по реализации
  fhir:ImplementationGuide.dependency [ # 0..* Другое руководство по реализации, от которого зависит данное
    fhir:ImplementationGuide.dependency.type [ code ]; # 1..1 reference | inclusion
    fhir:ImplementationGuide.dependency.uri [ uri ]; # 1..1 Где найти зависимость
  ], ...;
  fhir:ImplementationGuide.package [ # 0..* Группа ресурсов, использованных в .page.package
    fhir:ImplementationGuide.package.name [ string ]; # 1..1 Имя, используемое в .page.package
    fhir:ImplementationGuide.package.description [ string ]; # 0..1 Человекочитаемый текст, описывающий этот пакет
    fhir:ImplementationGuide.package.resource [ # 1..* Ресурс в руководстве по реализации
      fhir:ImplementationGuide.package.resource.example [ boolean ]; # 1..1 Если это не пример, то имеет своё обычное смысловое значение
      fhir:ImplementationGuide.package.resource.name [ string ]; # 0..1 Назначенное человеком имя ресурса
      fhir:ImplementationGuide.package.resource.description [ string ]; # 0..1 Причина включения в руководство
      fhir:ImplementationGuide.package.resource.acronym [ string ]; # 0..1 Короткий код для идентификации ресурса
      # ImplementationGuide.package.resource.source[x] : 1..1 Местонахождение ресурса. One of these 2
        fhir:ImplementationGuide.package.resource.sourceUri [ uri ]
        fhir:ImplementationGuide.package.resource.sourceReference [ Reference(Any) ]
      fhir:ImplementationGuide.package.resource.exampleFor [ Reference(StructureDefinition) ]; # 0..1 Ресурс, для которого приводится этот пример (если применимо)
    ], ...;
  ], ...;
  fhir:ImplementationGuide.global [ # 0..* Профили, применяемые глобально
    fhir:ImplementationGuide.global.type [ code ]; # 1..1 Тип ресурса, к которому применяется этот профиль
    fhir:ImplementationGuide.global.profile [ Reference(StructureDefinition) ]; # 1..1 Профиль, которому должны соответствовать все ресурсы
  ], ...;
  fhir:ImplementationGuide.binary [ uri ], ... ; # 0..* Изображение, каскадная таблица стилей, скрипт и т. п
  fhir:ImplementationGuide.page [ # 0..1 Страница/раздел руководства
    fhir:ImplementationGuide.page.source [ uri ]; # 1..1 Где найти эту страницу
    fhir:ImplementationGuide.page.title [ string ]; # 1..1 Short title shown for navigational assistance
    fhir:ImplementationGuide.page.kind [ code ]; # 1..1 page | example | list | include | directory | dictionary | toc | resource
    fhir:ImplementationGuide.page.type [ code ], ... ; # 0..* Kind of resource to include in the list
    fhir:ImplementationGuide.page.package [ string ], ... ; # 0..* Name of package to include
    fhir:ImplementationGuide.page.format [ code ]; # 0..1 Формат страницы (например html, markdown, др.)
    fhir:ImplementationGuide.page.page [ See ImplementationGuide.page ], ... ; # 0..* Вложенные страницы/разделы
  ];
]

Changes since DSTU2

ImplementationGuide
ImplementationGuide.status
  • Change value set from http://hl7.org/fhir/ValueSet/conformance-resource-status to http://hl7.org/fhir/ValueSet/publication-status
ImplementationGuide.experimental
  • Now marked as Modifier
ImplementationGuide.contact
  • Type changed from BackboneElement to ContactDetail
ImplementationGuide.description
  • Type changed from string to markdown
ImplementationGuide.useContext
  • Type changed from CodeableConcept to UsageContext
  • Remove Binding http://hl7.org/fhir/ValueSet/use-context (extensible)
ImplementationGuide.jurisdiction
  • Added Element
ImplementationGuide.copyright
  • Type changed from string to markdown
ImplementationGuide.package
  • Min Cardinality changed from 1 to 0
ImplementationGuide.package.resource.example
  • Added Element
ImplementationGuide.page
  • Min Cardinality changed from 1 to 0
ImplementationGuide.page.title
  • Renamed from name to title
ImplementationGuide.contact.name
  • deleted
ImplementationGuide.contact.telecom
  • deleted
ImplementationGuide.package.resource.purpose
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.).

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. ImplementationGuide DomainResourceНабор правил о том, как используется FHIR
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ1..1uriLogical URI to reference this implementation guide (globally unique)
... version Σ0..1stringBusiness version of the implementation guide
... name Σ1..1stringName for this implementation guide (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the implementation guide
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for implementation guide (if applicable)
Jurisdiction ValueSet (Extensible)
... copyright 0..1markdownUse and/or publishing restrictions
... fhirVersion Σ0..1idВерсия FHIR, которой соответствует это руководство по реализации
... dependency Σ0..*BackboneElementДругое руководство по реализации, от которого зависит данное
.... type Σ1..1codereference | inclusion
GuideDependencyType (Required)
.... uri Σ1..1uriГде найти зависимость
... package Σ0..*BackboneElementГруппа ресурсов, использованных в .page.package
.... name Σ1..1stringИмя, используемое в .page.package
.... description 0..1stringЧеловекочитаемый текст, описывающий этот пакет
.... resource Σ1..*BackboneElementРесурс в руководстве по реализации
..... example Σ1..1booleanЕсли это не пример, то имеет своё обычное смысловое значение
..... name Σ0..1stringНазначенное человеком имя ресурса
..... description 0..1stringПричина включения в руководство
..... acronym 0..1stringКороткий код для идентификации ресурса
..... source[x] Σ1..1Местонахождение ресурса
...... sourceUriuri
...... sourceReferenceReference(Any)
..... exampleFor 0..1Reference(StructureDefinition)Ресурс, для которого приводится этот пример (если применимо)
... global Σ0..*BackboneElementПрофили, применяемые глобально
.... type Σ1..1codeТип ресурса, к которому применяется этот профиль
ResourceType (Required)
.... profile Σ1..1Reference(StructureDefinition)Профиль, которому должны соответствовать все ресурсы
... binary 0..*uriИзображение, каскадная таблица стилей, скрипт и т. п
... page Σ0..1BackboneElementСтраница/раздел руководства
.... source Σ1..1uriГде найти эту страницу
.... title Σ1..1stringShort title shown for navigational assistance
.... kind Σ1..1codepage | example | list | include | directory | dictionary | toc | resource
GuidePageKind (Required)
.... type 0..*codeKind of resource to include in the list
ResourceType (Required)
.... package 0..*stringName of package to include
.... format 0..1codeФормат страницы (например html, markdown, др.)
MimeType (Required)
.... page 0..*see pageВложенные страницы/разделы

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

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

ImplementationGuide (DomainResource)An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](resource.html#versions)url : uri [1..1]The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [1..1]The status of this implementation guide. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! »A boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the implementation guide was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changesdate : dateTime [0..1]The name of the individual or organization that published the implementation guidepublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the implementation guide from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate implementation guide instancesuseContext : UsageContext [0..*]A legal or geographic region in which the implementation guide is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ »A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guidecopyright : markdown [0..1]The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.1.0 for this versionfhirVersion : id [0..1]Бинарный файл, включаемый в руководство по реализации при публикацииbinary : uri [0..*]DependencyТип зависимости после публикации руководстваtype : code [1..1] « Как зависимость будет представлена, когда руководство будет опубликовано. (Strength=Required)GuideDependencyType! »Где расположена эта зависимостьuri : uri [1..1]PackageИмя группы, используемое в page.packagename : string [1..1]Человекочитаемый текст, описывающий этот пакетdescription : string [0..1]ResourceВключён ли ресурс в руководство в составе правил, задаваемых руководством, или это просто пример ресурса, который соответствует этим правилам и/или помогает реализаторам понять назначение этого руководстваexample : boolean [1..1]Назначенное человеком имя ресурса. Все ресурсы должны иметь имя, однако это имя может извлекаться из ресурса (например ValueSet.name)name : string [0..1]Описание причины, по которой ресурс был включён в руководство по реализацииdescription : string [0..1]Короткий код, который можно использовать для идентификации ресурса в руководстве по реализацииacronym : string [0..1]Где находится этот ресурсsource[x] : Type [1..1] « uri|Reference(Any) »Другой ресурс, примером которого является данный ресурс. По большей части используется для ресурсов, включённых в качестве примеров ресурсов StructureDefinitionexampleFor : Reference [0..1] « StructureDefinition »GlobalТип ресурса, все экземпляры которого должны соответствовать профилюtype : code [1..1] « One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! »Ссылка на профиль, которому должны соответствовать все экземпляры [ресурса]profile : Reference [1..1] « StructureDefinition »PageАдрес источника для этой страницыsource : uri [1..1]A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etctitle : string [1..1]Тип страницы. Некоторые страницы генерируются автоматически (list, example), другие типы нужны для навигации пользователя к странице, представляющей интересkind : code [1..1] « Тип включённой страницы. (Strength=Required)GuidePageKind! »For constructed pages, what kind of resources to include in the listtype : code [0..*] « One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! »For constructed pages, a list of packages to include in the page (or else empty for everything)package : string [0..*]Формат страницыformat : code [0..1] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)MimeType! »Другое руководство по реализации, от которого зависит данное. Обычно в руководстве по реализации используются наборы значений, профили и др., определённые в других руководствах по реализацииdependency[0..*]Ресурс, являющийся частью руководства по реализации. Очевидными кандидатами для включения в руководство являются ресурсы обеспечения соответствия (набор значений, структурное определение, заявления о соответствии и др.), однако для включения в качестве примера разрешены все виды ресурсовresource[1..*]Логическая группа ресурсов. Логические группы используются при построении страницpackage[0..*]Ряд профилей, которым должны соответствовать все ресурсы, охватываемые данным руководством по реализацииglobal[0..*]Вложенные страницы/разделы для этой страницыpage[0..*]Страница/раздел в руководстве по реализации. Корневой страницей является главная ("домашняя") страница руководства по реализацииpage[0..1]

XML-шаблон

<ImplementationGuide xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 1..1 Logical URI to reference this implementation guide (globally unique) -->
 <version value="[string]"/><!-- 0..1 Business version of the implementation guide -->
 <name value="[string]"/><!-- 1..1 Name for this implementation guide (computer friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the implementation guide -->
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for implementation guide (if applicable) --></jurisdiction>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <fhirVersion value="[id]"/><!-- 0..1 Версия FHIR, которой соответствует это руководство по реализации -->
 <dependency>  <!-- 0..* Другое руководство по реализации, от которого зависит данное -->
  <type value="[code]"/><!-- 1..1 reference | inclusion -->
  <uri value="[uri]"/><!-- 1..1 Где найти зависимость -->
 </dependency>
 <package>  <!-- 0..* Группа ресурсов, использованных в .page.package -->
  <name value="[string]"/><!-- 1..1 Имя, используемое в .page.package -->
  <description value="[string]"/><!-- 0..1 Человекочитаемый текст, описывающий этот пакет -->
  <resource>  <!-- 1..* Ресурс в руководстве по реализации -->
   <example value="[boolean]"/><!-- 1..1 Если это не пример, то имеет своё обычное смысловое значение -->
   <name value="[string]"/><!-- 0..1 Назначенное человеком имя ресурса -->
   <description value="[string]"/><!-- 0..1 Причина включения в руководство -->
   <acronym value="[string]"/><!-- 0..1 Короткий код для идентификации ресурса -->
   <source[x]><!-- 1..1 uri|Reference(Any) Местонахождение ресурса --></source[x]>
   <exampleFor><!-- 0..1 Reference(StructureDefinition) Ресурс, для которого приводится этот пример (если применимо) --></exampleFor>
  </resource>
 </package>
 <global>  <!-- 0..* Профили, применяемые глобально -->
  <type value="[code]"/><!-- 1..1 Тип ресурса, к которому применяется этот профиль -->
  <profile><!-- 1..1 Reference(StructureDefinition) Профиль, которому должны соответствовать все ресурсы --></profile>
 </global>
 <binary value="[uri]"/><!-- 0..* Изображение, каскадная таблица стилей, скрипт и т. п -->
 <page>  <!-- 0..1 Страница/раздел руководства -->
  <source value="[uri]"/><!-- 1..1 Где найти эту страницу -->
  <title value="[string]"/><!-- 1..1 Short title shown for navigational assistance -->
  <kind value="[code]"/><!-- 1..1 page | example | list | include | directory | dictionary | toc | resource -->
  <type value="[code]"/><!-- 0..* Kind of resource to include in the list -->
  <package value="[string]"/><!-- 0..* Name of package to include -->
  <format value="[code]"/><!-- 0..1 Формат страницы (например html, markdown, др.)  -->
  <page><!-- 0..* Content as for ImplementationGuide.page Вложенные страницы/разделы --></page>
 </page>
</ImplementationGuide>

JSON-шаблон

{doco
  "resourceType" : "ImplementationGuide",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Logical URI to reference this implementation guide (globally unique)
  "version" : "<string>", // Business version of the implementation guide
  "name" : "<string>", // R!  Name for this implementation guide (computer friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the implementation guide
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for implementation guide (if applicable)
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "fhirVersion" : "<id>", // Версия FHIR, которой соответствует это руководство по реализации
  "dependency" : [{ // Другое руководство по реализации, от которого зависит данное
    "type" : "<code>", // R!  reference | inclusion
    "uri" : "<uri>" // R!  Где найти зависимость
  }],
  "package" : [{ // Группа ресурсов, использованных в .page.package
    "name" : "<string>", // R!  Имя, используемое в .page.package
    "description" : "<string>", // Человекочитаемый текст, описывающий этот пакет
    "resource" : [{ // R!  Ресурс в руководстве по реализации
      "example" : <boolean>, // R!  Если это не пример, то имеет своё обычное смысловое значение
      "name" : "<string>", // Назначенное человеком имя ресурса
      "description" : "<string>", // Причина включения в руководство
      "acronym" : "<string>", // Короткий код для идентификации ресурса
      // source[x]: Местонахождение ресурса. One of these 2:
      "sourceUri" : "<uri>",
      "sourceReference" : { Reference(Any) },
      "exampleFor" : { Reference(StructureDefinition) } // Ресурс, для которого приводится этот пример (если применимо)
    }]
  }],
  "global" : [{ // Профили, применяемые глобально
    "type" : "<code>", // R!  Тип ресурса, к которому применяется этот профиль
    "profile" : { Reference(StructureDefinition) } // R!  Профиль, которому должны соответствовать все ресурсы
  }],
  "binary" : ["<uri>"], // Изображение, каскадная таблица стилей, скрипт и т. п
  "page" : { // Страница/раздел руководства
    "source" : "<uri>", // R!  Где найти эту страницу
    "title" : "<string>", // R!  Short title shown for navigational assistance
    "kind" : "<code>", // R!  page | example | list | include | directory | dictionary | toc | resource
    "type" : ["<code>"], // Kind of resource to include in the list
    "package" : ["<string>"], // Name of package to include
    "format" : "<code>", // Формат страницы (например html, markdown, др.) 
    "page" : [{ Content as for ImplementationGuide.page }] // Вложенные страницы/разделы
  }
}

Turtle-шаблон

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


[ a fhir:ImplementationGuide;
  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:ImplementationGuide.url [ uri ]; # 1..1 Logical URI to reference this implementation guide (globally unique)
  fhir:ImplementationGuide.version [ string ]; # 0..1 Business version of the implementation guide
  fhir:ImplementationGuide.name [ string ]; # 1..1 Name for this implementation guide (computer friendly)
  fhir:ImplementationGuide.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ImplementationGuide.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ImplementationGuide.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:ImplementationGuide.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ImplementationGuide.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ImplementationGuide.description [ markdown ]; # 0..1 Natural language description of the implementation guide
  fhir:ImplementationGuide.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:ImplementationGuide.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for implementation guide (if applicable)
  fhir:ImplementationGuide.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ImplementationGuide.fhirVersion [ id ]; # 0..1 Версия FHIR, которой соответствует это руководство по реализации
  fhir:ImplementationGuide.dependency [ # 0..* Другое руководство по реализации, от которого зависит данное
    fhir:ImplementationGuide.dependency.type [ code ]; # 1..1 reference | inclusion
    fhir:ImplementationGuide.dependency.uri [ uri ]; # 1..1 Где найти зависимость
  ], ...;
  fhir:ImplementationGuide.package [ # 0..* Группа ресурсов, использованных в .page.package
    fhir:ImplementationGuide.package.name [ string ]; # 1..1 Имя, используемое в .page.package
    fhir:ImplementationGuide.package.description [ string ]; # 0..1 Человекочитаемый текст, описывающий этот пакет
    fhir:ImplementationGuide.package.resource [ # 1..* Ресурс в руководстве по реализации
      fhir:ImplementationGuide.package.resource.example [ boolean ]; # 1..1 Если это не пример, то имеет своё обычное смысловое значение
      fhir:ImplementationGuide.package.resource.name [ string ]; # 0..1 Назначенное человеком имя ресурса
      fhir:ImplementationGuide.package.resource.description [ string ]; # 0..1 Причина включения в руководство
      fhir:ImplementationGuide.package.resource.acronym [ string ]; # 0..1 Короткий код для идентификации ресурса
      # ImplementationGuide.package.resource.source[x] : 1..1 Местонахождение ресурса. One of these 2
        fhir:ImplementationGuide.package.resource.sourceUri [ uri ]
        fhir:ImplementationGuide.package.resource.sourceReference [ Reference(Any) ]
      fhir:ImplementationGuide.package.resource.exampleFor [ Reference(StructureDefinition) ]; # 0..1 Ресурс, для которого приводится этот пример (если применимо)
    ], ...;
  ], ...;
  fhir:ImplementationGuide.global [ # 0..* Профили, применяемые глобально
    fhir:ImplementationGuide.global.type [ code ]; # 1..1 Тип ресурса, к которому применяется этот профиль
    fhir:ImplementationGuide.global.profile [ Reference(StructureDefinition) ]; # 1..1 Профиль, которому должны соответствовать все ресурсы
  ], ...;
  fhir:ImplementationGuide.binary [ uri ], ... ; # 0..* Изображение, каскадная таблица стилей, скрипт и т. п
  fhir:ImplementationGuide.page [ # 0..1 Страница/раздел руководства
    fhir:ImplementationGuide.page.source [ uri ]; # 1..1 Где найти эту страницу
    fhir:ImplementationGuide.page.title [ string ]; # 1..1 Short title shown for navigational assistance
    fhir:ImplementationGuide.page.kind [ code ]; # 1..1 page | example | list | include | directory | dictionary | toc | resource
    fhir:ImplementationGuide.page.type [ code ], ... ; # 0..* Kind of resource to include in the list
    fhir:ImplementationGuide.page.package [ string ], ... ; # 0..* Name of package to include
    fhir:ImplementationGuide.page.format [ code ]; # 0..1 Формат страницы (например html, markdown, др.)
    fhir:ImplementationGuide.page.page [ See ImplementationGuide.page ], ... ; # 0..* Вложенные страницы/разделы
  ];
]

Changes since DSTU2

ImplementationGuide
ImplementationGuide.status
  • Change value set from http://hl7.org/fhir/ValueSet/conformance-resource-status to http://hl7.org/fhir/ValueSet/publication-status
ImplementationGuide.experimental
  • Now marked as Modifier
ImplementationGuide.contact
  • Type changed from BackboneElement to ContactDetail
ImplementationGuide.description
  • Type changed from string to markdown
ImplementationGuide.useContext
  • Type changed from CodeableConcept to UsageContext
  • Remove Binding http://hl7.org/fhir/ValueSet/use-context (extensible)
ImplementationGuide.jurisdiction
  • Added Element
ImplementationGuide.copyright
  • Type changed from string to markdown
ImplementationGuide.package
  • Min Cardinality changed from 1 to 0
ImplementationGuide.package.resource.example
  • Added Element
ImplementationGuide.page
  • Min Cardinality changed from 1 to 0
ImplementationGuide.page.title
  • Renamed from name to title
ImplementationGuide.contact.name
  • deleted
ImplementationGuide.contact.telecom
  • deleted
ImplementationGuide.package.resource.purpose
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and all r3 resources are valid.).

 

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

ПутьОписаниеТипСсылка
ImplementationGuide.status The lifecycle status of a Value Set or Concept Map.RequiredPublicationStatus
ImplementationGuide.jurisdiction Countries and regions within which this artifact is targeted for useExtensibleJurisdiction ValueSet
ImplementationGuide.dependency.type Как зависимость будет представлена, когда руководство будет опубликовано.RequiredGuideDependencyType
ImplementationGuide.global.type
ImplementationGuide.page.type
One of the resource types defined as part of FHIR.RequiredResource Types
ImplementationGuide.page.kind Тип включённой страницы.RequiredGuidePageKind
ImplementationGuide.page.format The mime type of an attachment. Any valid mime type is allowed.RequiredBCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

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

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

В этой таблице приведены данные о совместимости различных ресурсов, полученные с помощью инструмента сравнения руководств по реализации:

Ещё предстоит сделать

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

ИмяТипОписаниеВыражениеIn Common
datedateThe implementation guide publication dateImplementationGuide.date
dependencyuriГде найти зависимостьImplementationGuide.dependency.uri
descriptionstringThe description of the implementation guideImplementationGuide.description
experimentaltokenFor testing purposes, not real usageImplementationGuide.experimental
jurisdictiontokenIntended jurisdiction for the implementation guideImplementationGuide.jurisdiction
namestringComputationally friendly name of the implementation guideImplementationGuide.name
publisherstringName of the publisher of the implementation guideImplementationGuide.publisher
resourcereferenceМестонахождение ресурсаImplementationGuide.package.resource.source
(Any)
statustokenThe current status of the implementation guideImplementationGuide.status
urluriThe uri that identifies the implementation guideImplementationGuide.url
versiontokenThe business version of the implementation guideImplementationGuide.version