Руководство к использованию стандарта FHIR в ЦИСЗ
0.1.1667 - ci-build
Руководство к использованию стандарта FHIR в ЦИСЗ - Local Development build (v0.1.1667) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Официальный URL: https://fhir.by/StructureDefinition/OrganizationBy | Version: 0.1.1667 | |||
Active as of 2024-09-16 | Имя: OrganizationBy |
Профиль государственного учреждения здравоохранния в РБ (Юридического лица).
Описание профиля
Профиль предназначен для записи сведений об организации здравоохранения и включает в себя следующие данные:
Профиль используется в следующих случаях:
Usage:
Описание профилей и принципов работы различных представлений..
Профиль ресурса: Organization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | Organization | учреждение здравоохранения оказывающее медицинские услуги населению identifierRuleForOKPO: Правило для регистрационного номера ОКПО - 12 цифр identifierRuleForUNP: Правило для УНП - 9 цифр |
id | 1..1 | id | Логический идентификатор этого артефакта | |
meta | 1..1 | Meta | Метаданные о ресурсе | |
id | 0..0 | |||
extension | 0..0 | |||
versionId | 0..0 | |||
lastUpdated | 0..0 | |||
source | 0..0 | |||
profile | 1..1 | canonical(StructureDefinition) | Профили, которым, как утверждается, соответствует этот ресурс Required Pattern: https://fhir.by/StructureDefinition/OrganizationBy | |
security | 0..0 | |||
tag | 0..0 | |||
implicitRules | 0..0 | |||
language | 0..0 | |||
contained | 0..0 | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
healthCareLevel | S | 0..1 | CodeableConcept | Уровень оказания медицинской помощи URL: https://fhir.by/StructureDefinition/HealthCareLevel Binding: Уровни оказания помощи (required) |
formOfOwnership | S | 0..1 | CodeableConcept | Форма собственности URL: https://fhir.by/StructureDefinition/FormOfOwnership Binding: Коды ОКРБ 002-2019 (required) |
сodeUNP | S | 0..1 | string | УНП URL: https://fhir.by/StructureDefinition/CodeUNP |
isSubordinated | S | 0..1 | CodeableConcept | Подчиненность организаций здравоохранения URL: https://fhir.by/StructureDefinition/IsSubordinated Binding: Подчиненность организаций здравоохранения (required) |
higherLevelOrganization | S | 0..1 | CodeableConcept | Вышестоящая организация URL: https://fhir.by/StructureDefinition/HigherLevelOrganization Binding: Вышестоящая организация (required) |
termsOfService | S | 0..4 | CodeableConcept | Условия оказания медцинской помощи URL: https://fhir.by/StructureDefinition/TermsOfService Binding: Условия оказания медцинской помощи (required) |
typeOfHealthCare | S | 0..5 | CodeableConcept | Вид медицинской помощи URL: https://fhir.by/StructureDefinition/TypeOfHealthCare Binding: Вид медицинской помощи (required) |
organizationRegistration | S | 0..1 | (Complex) | Информация о регистрации организации URL: https://fhir.by/StructureDefinition/OrganizationRegistration |
organizationStructure | S | 0..1 | CodeableConcept | Структура здравоохранения URL: https://fhir.by/StructureDefinition/OrganizationStructure Binding: Структура здравоохранения (required) |
modifierExtension | 0..0 | |||
identifier | 1..* | Identifier | Идентифицирует эту организацию в нескольких системах | |
id | 0..0 | |||
extension | 0..0 | |||
use | 0..0 | |||
type | 0..0 | |||
system | 1..1 | uri | Пространство имен для значения идентификатора | |
value | 1..1 | string | Длина ОКПО равна 12 цифровым десятичным знакам, из которых первые 7 не имеют дополнительной смысловой нагрузки; восьмой знак представляет собой расчетное контрольное число; девятый знак соответствует первому знаку кода территории, на которой зарегистрирован респондент, в соответствии с общегосударственным классификатором ОКРБ 003-2017 «Система обозначений объектов административно-территориального деления» (далее – СОАТО), а 3 последних знака служат для выделения обособленных подразделений юридического лица. | |
period | 0..1 | Period | Дата регистрации в ЕГР | |
id | 0..0 | |||
extension | 0..0 | |||
start | 1..1 | dateTime | Начало периода действия | |
assigner | 0..0 | |||
active | 1..1 | boolean | Активно ли по-прежнему используются данные организации | |
type | 1..1 | CodeableConcept | Kind of organization | |
coding | 1..1 | Coding | Код, определенный терминологической системой | |
system | 1..1 | uri | Идентичность терминологической системы Required Pattern: https://fhir.by/CodeSystem/CSTypeOfOrganization | |
code | 1..1 | code | Код в синтаксисе, определенном системой Binding: Тип медицинской организации (required) | |
name | 1..1 | string | Полное название, используемое для организации | |
alias | 0..2 | string | Сокращенное название, используемое для организации | |
contact | 1..1 | ExtendedContactDetail | Официальные контактные данные организации | |
id | 0..0 | |||
extension | 0..0 | |||
purpose | 0..0 | |||
name | 0..0 | |||
telecom | 1..* | ContactPoint | Контактные данные (например, телефон/факс/url) | |
id | 0..0 | |||
extension | 0..0 | |||
system | 1..1 | code | phone | fax | email | pager | url | sms | other | |
value | 1..1 | string | Актуальная информация о контактном точке | |
use | 0..0 | |||
rank | 0..0 | |||
period | 0..0 | |||
address | 1..1 | Address | Адрес | |
id | 0..0 | |||
extension | 0..1 | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
codeSDATO | S | 0..1 | string | Код СОАТО URL: https://fhir.by/StructureDefinition/CodeSDATO |
use | 0..0 | |||
type | 0..0 | |||
line | 1..1 | string | Название улицы, номер дома/строения, корпус, номер квартиры/помещения, номер абонентского ящика и прочее. | |
city | 0..0 | |||
district | 0..0 | |||
state | 0..0 | |||
postalCode | 1..1 | string | Почтовый индекс | |
country | 0..0 | |||
period | 0..0 | |||
organization | 0..0 | |||
partOf | 0..1 | Reference(Organization) | Частью какой организации является | |
endpoint | 0..0 | |||
qualification | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type.coding.code | required | VSTypeOfOrganization (a valid code from Тип медицинской организации)https://fhir.by/ValueSet/VSTypeOfOrganization from this IG |
Id | Grade | Path(s) | Details | Requirements |
identifierRuleForOKPO | error | Organization | Правило для регистрационного номера ОКПО - 12 цифр : identifier.value.matches('^[0-9]{12}$') | |
identifierRuleForUNP | error | Organization | Правило для УНП - 9 цифр : extension('https://fhir.by/StructureDefinition/CodeUNP').value.matches('^[0-9]{9}$') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | Organization | учреждение здравоохранения оказывающее медицинские услуги населению org-1: The organization SHALL at least have a name or an identifier, and possibly more than one identifierRuleForOKPO: Правило для регистрационного номера ОКПО - 12 цифр identifierRuleForUNP: Правило для УНП - 9 цифр |
id | Σ | 1..1 | id | Логический идентификатор этого артефакта |
meta | Σ | 1..1 | Meta | Метаданные о ресурсе |
extension | 0..0 | |||
profile | Σ | 1..1 | canonical(StructureDefinition) | Профили, которым, как утверждается, соответствует этот ресурс Required Pattern: https://fhir.by/StructureDefinition/OrganizationBy |
text | 0..1 | Narrative | Краткое изложение текста ресурса для интерпретации человеком | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
healthCareLevel | S | 0..1 | CodeableConcept | Уровень оказания медицинской помощи URL: https://fhir.by/StructureDefinition/HealthCareLevel Binding: Уровни оказания помощи (required) |
formOfOwnership | S | 0..1 | CodeableConcept | Форма собственности URL: https://fhir.by/StructureDefinition/FormOfOwnership Binding: Коды ОКРБ 002-2019 (required) |
сodeUNP | S | 0..1 | string | УНП URL: https://fhir.by/StructureDefinition/CodeUNP |
isSubordinated | S | 0..1 | CodeableConcept | Подчиненность организаций здравоохранения URL: https://fhir.by/StructureDefinition/IsSubordinated Binding: Подчиненность организаций здравоохранения (required) |
higherLevelOrganization | S | 0..1 | CodeableConcept | Вышестоящая организация URL: https://fhir.by/StructureDefinition/HigherLevelOrganization Binding: Вышестоящая организация (required) |
termsOfService | S | 0..4 | CodeableConcept | Условия оказания медцинской помощи URL: https://fhir.by/StructureDefinition/TermsOfService Binding: Условия оказания медцинской помощи (required) |
typeOfHealthCare | S | 0..5 | CodeableConcept | Вид медицинской помощи URL: https://fhir.by/StructureDefinition/TypeOfHealthCare Binding: Вид медицинской помощи (required) |
organizationRegistration | S | 0..1 | (Complex) | Информация о регистрации организации URL: https://fhir.by/StructureDefinition/OrganizationRegistration |
organizationStructure | S | 0..1 | CodeableConcept | Структура здравоохранения URL: https://fhir.by/StructureDefinition/OrganizationStructure Binding: Структура здравоохранения (required) |
identifier | ΣC | 1..* | Identifier | Идентифицирует эту организацию в нескольких системах |
extension | 0..0 | |||
system | Σ | 1..1 | uri | Пространство имен для значения идентификатора Example General: http://www.acme.com/identifiers/patient |
value | ΣC | 1..1 | string | Длина ОКПО равна 12 цифровым десятичным знакам, из которых первые 7 не имеют дополнительной смысловой нагрузки; восьмой знак представляет собой расчетное контрольное число; девятый знак соответствует первому знаку кода территории, на которой зарегистрирован респондент, в соответствии с общегосударственным классификатором ОКРБ 003-2017 «Система обозначений объектов административно-территориального деления» (далее – СОАТО),
а 3 последних знака служат для выделения обособленных подразделений юридического лица. Example General: 123456 |
period | Σ | 0..1 | Period | Дата регистрации в ЕГР |
extension | 0..0 | |||
start | ΣC | 1..1 | dateTime | Начало периода действия |
end | ΣC | 0..1 | dateTime | Конец периода действия |
active | ?!Σ | 1..1 | boolean | Активно ли по-прежнему используются данные организации |
type | Σ | 1..1 | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. |
id | 0..1 | id | Уникальный идентификатор для межэлементных ссылок | |
extension | 0..* | Extension | Дополнительный контент, определяемый реализациями Slice: Unordered, Open by value:url | |
coding | Σ | 1..1 | Coding | Код, определенный терминологической системой |
id | 0..1 | id | Уникальный идентификатор для межэлементных ссылок | |
extension | 0..* | Extension | Дополнительный контент, определенный реализациями Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Идентичность терминологической системы Required Pattern: https://fhir.by/CodeSystem/CSTypeOfOrganization |
version | Σ | 0..1 | string | Версия системы - если это уместно |
code | ΣC | 1..1 | code | Код в синтаксисе, определенном системой Binding: Тип медицинской организации (required) |
display | ΣC | 0..1 | string | Представление, определяемое системой |
userSelected | Σ | 0..1 | boolean | Если эта кодировка была выбрана непосредственно пользователем |
text | Σ | 0..1 | string | Простое текстовое представление концепции |
name | ΣC | 1..1 | string | Полное название, используемое для организации |
alias | 0..2 | string | Сокращенное название, используемое для организации | |
description | Σ | 0..1 | markdown | Дополнительные сведения об организации, которые могут быть отображены в качестве дополнительной информации для идентификации организации помимо ее названия |
contact | C | 1..1 | ExtendedContactDetail | Официальные контактные данные организации org-3: The telecom of an organization can never be of use 'home' org-4: The address of an organization can never be of use 'home' |
extension | 0..0 | |||
telecom | Σ | 1..* | ContactPoint | Контактные данные (например, телефон/факс/url) |
extension | 0..0 | |||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Телекоммуникационная форма для контактного пункта. |
value | ΣC | 1..1 | string | Актуальная информация о контактном точке |
address | Σ | 1..1 | Address | Адрес |
Slices for extension | 0..1 | Extension | Extension Slice: Unordered, Open by value:url | |
codeSDATO | S | 0..1 | string | Код СОАТО URL: https://fhir.by/StructureDefinition/CodeSDATO |
text | Σ | 0..1 | string | Текстовое представление адреса Example General: 220099, Минск, пр-т Победителей, 2, корп. 3, кв. 40 |
line | Σ | 1..1 | string | Название улицы, номер дома/строения, корпус, номер квартиры/помещения, номер абонентского ящика и прочее. This repeating element order: Порядок, в котором строки должны появляться в адресной метке Example General: пр-т Победителей, 2, корп. 3, кв. 40 |
postalCode | Σ | 1..1 | string | Почтовый индекс Example General: 220099 |
period | Σ | 0..1 | Period | Период, в течение которого этот контакт был действителен для использования |
partOf | Σ | 0..1 | Reference(Organization) | Частью какой организации является |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-type from the FHIR Standard | |
Organization.type.coding.code | required | VSTypeOfOrganization (a valid code from Тип медицинской организации)https://fhir.by/ValueSet/VSTypeOfOrganization from this IG | |
Organization.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Organization.qualification.code | example |
Id | Grade | Path(s) | Details | Requirements |
identifierRuleForOKPO | error | Organization | Правило для регистрационного номера ОКПО - 12 цифр : identifier.value.matches('^[0-9]{12}$') | |
identifierRuleForUNP | error | Organization | Правило для УНП - 9 цифр : extension('https://fhir.by/StructureDefinition/CodeUNP').value.matches('^[0-9]{9}$') |
Профиль ресурса: Organization
Summary
Mandatory: 19 elements(3 nested mandatory elements)
Must-Support: 10 elements
Prohibited: 38 elements
Extensions
This structure refers to these extensions:
Схема различий
Профиль ресурса: Organization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | Organization | учреждение здравоохранения оказывающее медицинские услуги населению identifierRuleForOKPO: Правило для регистрационного номера ОКПО - 12 цифр identifierRuleForUNP: Правило для УНП - 9 цифр |
id | 1..1 | id | Логический идентификатор этого артефакта | |
meta | 1..1 | Meta | Метаданные о ресурсе | |
id | 0..0 | |||
extension | 0..0 | |||
versionId | 0..0 | |||
lastUpdated | 0..0 | |||
source | 0..0 | |||
profile | 1..1 | canonical(StructureDefinition) | Профили, которым, как утверждается, соответствует этот ресурс Required Pattern: https://fhir.by/StructureDefinition/OrganizationBy | |
security | 0..0 | |||
tag | 0..0 | |||
implicitRules | 0..0 | |||
language | 0..0 | |||
contained | 0..0 | |||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
healthCareLevel | S | 0..1 | CodeableConcept | Уровень оказания медицинской помощи URL: https://fhir.by/StructureDefinition/HealthCareLevel Binding: Уровни оказания помощи (required) |
formOfOwnership | S | 0..1 | CodeableConcept | Форма собственности URL: https://fhir.by/StructureDefinition/FormOfOwnership Binding: Коды ОКРБ 002-2019 (required) |
сodeUNP | S | 0..1 | string | УНП URL: https://fhir.by/StructureDefinition/CodeUNP |
isSubordinated | S | 0..1 | CodeableConcept | Подчиненность организаций здравоохранения URL: https://fhir.by/StructureDefinition/IsSubordinated Binding: Подчиненность организаций здравоохранения (required) |
higherLevelOrganization | S | 0..1 | CodeableConcept | Вышестоящая организация URL: https://fhir.by/StructureDefinition/HigherLevelOrganization Binding: Вышестоящая организация (required) |
termsOfService | S | 0..4 | CodeableConcept | Условия оказания медцинской помощи URL: https://fhir.by/StructureDefinition/TermsOfService Binding: Условия оказания медцинской помощи (required) |
typeOfHealthCare | S | 0..5 | CodeableConcept | Вид медицинской помощи URL: https://fhir.by/StructureDefinition/TypeOfHealthCare Binding: Вид медицинской помощи (required) |
organizationRegistration | S | 0..1 | (Complex) | Информация о регистрации организации URL: https://fhir.by/StructureDefinition/OrganizationRegistration |
organizationStructure | S | 0..1 | CodeableConcept | Структура здравоохранения URL: https://fhir.by/StructureDefinition/OrganizationStructure Binding: Структура здравоохранения (required) |
modifierExtension | 0..0 | |||
identifier | 1..* | Identifier | Идентифицирует эту организацию в нескольких системах | |
id | 0..0 | |||
extension | 0..0 | |||
use | 0..0 | |||
type | 0..0 | |||
system | 1..1 | uri | Пространство имен для значения идентификатора | |
value | 1..1 | string | Длина ОКПО равна 12 цифровым десятичным знакам, из которых первые 7 не имеют дополнительной смысловой нагрузки; восьмой знак представляет собой расчетное контрольное число; девятый знак соответствует первому знаку кода территории, на которой зарегистрирован респондент, в соответствии с общегосударственным классификатором ОКРБ 003-2017 «Система обозначений объектов административно-территориального деления» (далее – СОАТО), а 3 последних знака служат для выделения обособленных подразделений юридического лица. | |
period | 0..1 | Period | Дата регистрации в ЕГР | |
id | 0..0 | |||
extension | 0..0 | |||
start | 1..1 | dateTime | Начало периода действия | |
assigner | 0..0 | |||
active | 1..1 | boolean | Активно ли по-прежнему используются данные организации | |
type | 1..1 | CodeableConcept | Kind of organization | |
coding | 1..1 | Coding | Код, определенный терминологической системой | |
system | 1..1 | uri | Идентичность терминологической системы Required Pattern: https://fhir.by/CodeSystem/CSTypeOfOrganization | |
code | 1..1 | code | Код в синтаксисе, определенном системой Binding: Тип медицинской организации (required) | |
name | 1..1 | string | Полное название, используемое для организации | |
alias | 0..2 | string | Сокращенное название, используемое для организации | |
contact | 1..1 | ExtendedContactDetail | Официальные контактные данные организации | |
id | 0..0 | |||
extension | 0..0 | |||
purpose | 0..0 | |||
name | 0..0 | |||
telecom | 1..* | ContactPoint | Контактные данные (например, телефон/факс/url) | |
id | 0..0 | |||
extension | 0..0 | |||
system | 1..1 | code | phone | fax | email | pager | url | sms | other | |
value | 1..1 | string | Актуальная информация о контактном точке | |
use | 0..0 | |||
rank | 0..0 | |||
period | 0..0 | |||
address | 1..1 | Address | Адрес | |
id | 0..0 | |||
extension | 0..1 | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
codeSDATO | S | 0..1 | string | Код СОАТО URL: https://fhir.by/StructureDefinition/CodeSDATO |
use | 0..0 | |||
type | 0..0 | |||
line | 1..1 | string | Название улицы, номер дома/строения, корпус, номер квартиры/помещения, номер абонентского ящика и прочее. | |
city | 0..0 | |||
district | 0..0 | |||
state | 0..0 | |||
postalCode | 1..1 | string | Почтовый индекс | |
country | 0..0 | |||
period | 0..0 | |||
organization | 0..0 | |||
partOf | 0..1 | Reference(Organization) | Частью какой организации является | |
endpoint | 0..0 | |||
qualification | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type.coding.code | required | VSTypeOfOrganization (a valid code from Тип медицинской организации)https://fhir.by/ValueSet/VSTypeOfOrganization from this IG |
Id | Grade | Path(s) | Details | Requirements |
identifierRuleForOKPO | error | Organization | Правило для регистрационного номера ОКПО - 12 цифр : identifier.value.matches('^[0-9]{12}$') | |
identifierRuleForUNP | error | Organization | Правило для УНП - 9 цифр : extension('https://fhir.by/StructureDefinition/CodeUNP').value.matches('^[0-9]{9}$') |
Полная Схема
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | Organization | учреждение здравоохранения оказывающее медицинские услуги населению org-1: The organization SHALL at least have a name or an identifier, and possibly more than one identifierRuleForOKPO: Правило для регистрационного номера ОКПО - 12 цифр identifierRuleForUNP: Правило для УНП - 9 цифр |
id | Σ | 1..1 | id | Логический идентификатор этого артефакта |
meta | Σ | 1..1 | Meta | Метаданные о ресурсе |
extension | 0..0 | |||
profile | Σ | 1..1 | canonical(StructureDefinition) | Профили, которым, как утверждается, соответствует этот ресурс Required Pattern: https://fhir.by/StructureDefinition/OrganizationBy |
text | 0..1 | Narrative | Краткое изложение текста ресурса для интерпретации человеком | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
healthCareLevel | S | 0..1 | CodeableConcept | Уровень оказания медицинской помощи URL: https://fhir.by/StructureDefinition/HealthCareLevel Binding: Уровни оказания помощи (required) |
formOfOwnership | S | 0..1 | CodeableConcept | Форма собственности URL: https://fhir.by/StructureDefinition/FormOfOwnership Binding: Коды ОКРБ 002-2019 (required) |
сodeUNP | S | 0..1 | string | УНП URL: https://fhir.by/StructureDefinition/CodeUNP |
isSubordinated | S | 0..1 | CodeableConcept | Подчиненность организаций здравоохранения URL: https://fhir.by/StructureDefinition/IsSubordinated Binding: Подчиненность организаций здравоохранения (required) |
higherLevelOrganization | S | 0..1 | CodeableConcept | Вышестоящая организация URL: https://fhir.by/StructureDefinition/HigherLevelOrganization Binding: Вышестоящая организация (required) |
termsOfService | S | 0..4 | CodeableConcept | Условия оказания медцинской помощи URL: https://fhir.by/StructureDefinition/TermsOfService Binding: Условия оказания медцинской помощи (required) |
typeOfHealthCare | S | 0..5 | CodeableConcept | Вид медицинской помощи URL: https://fhir.by/StructureDefinition/TypeOfHealthCare Binding: Вид медицинской помощи (required) |
organizationRegistration | S | 0..1 | (Complex) | Информация о регистрации организации URL: https://fhir.by/StructureDefinition/OrganizationRegistration |
organizationStructure | S | 0..1 | CodeableConcept | Структура здравоохранения URL: https://fhir.by/StructureDefinition/OrganizationStructure Binding: Структура здравоохранения (required) |
identifier | ΣC | 1..* | Identifier | Идентифицирует эту организацию в нескольких системах |
extension | 0..0 | |||
system | Σ | 1..1 | uri | Пространство имен для значения идентификатора Example General: http://www.acme.com/identifiers/patient |
value | ΣC | 1..1 | string | Длина ОКПО равна 12 цифровым десятичным знакам, из которых первые 7 не имеют дополнительной смысловой нагрузки; восьмой знак представляет собой расчетное контрольное число; девятый знак соответствует первому знаку кода территории, на которой зарегистрирован респондент, в соответствии с общегосударственным классификатором ОКРБ 003-2017 «Система обозначений объектов административно-территориального деления» (далее – СОАТО),
а 3 последних знака служат для выделения обособленных подразделений юридического лица. Example General: 123456 |
period | Σ | 0..1 | Period | Дата регистрации в ЕГР |
extension | 0..0 | |||
start | ΣC | 1..1 | dateTime | Начало периода действия |
end | ΣC | 0..1 | dateTime | Конец периода действия |
active | ?!Σ | 1..1 | boolean | Активно ли по-прежнему используются данные организации |
type | Σ | 1..1 | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. |
id | 0..1 | id | Уникальный идентификатор для межэлементных ссылок | |
extension | 0..* | Extension | Дополнительный контент, определяемый реализациями Slice: Unordered, Open by value:url | |
coding | Σ | 1..1 | Coding | Код, определенный терминологической системой |
id | 0..1 | id | Уникальный идентификатор для межэлементных ссылок | |
extension | 0..* | Extension | Дополнительный контент, определенный реализациями Slice: Unordered, Open by value:url | |
system | Σ | 1..1 | uri | Идентичность терминологической системы Required Pattern: https://fhir.by/CodeSystem/CSTypeOfOrganization |
version | Σ | 0..1 | string | Версия системы - если это уместно |
code | ΣC | 1..1 | code | Код в синтаксисе, определенном системой Binding: Тип медицинской организации (required) |
display | ΣC | 0..1 | string | Представление, определяемое системой |
userSelected | Σ | 0..1 | boolean | Если эта кодировка была выбрана непосредственно пользователем |
text | Σ | 0..1 | string | Простое текстовое представление концепции |
name | ΣC | 1..1 | string | Полное название, используемое для организации |
alias | 0..2 | string | Сокращенное название, используемое для организации | |
description | Σ | 0..1 | markdown | Дополнительные сведения об организации, которые могут быть отображены в качестве дополнительной информации для идентификации организации помимо ее названия |
contact | C | 1..1 | ExtendedContactDetail | Официальные контактные данные организации org-3: The telecom of an organization can never be of use 'home' org-4: The address of an organization can never be of use 'home' |
extension | 0..0 | |||
telecom | Σ | 1..* | ContactPoint | Контактные данные (например, телефон/факс/url) |
extension | 0..0 | |||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Телекоммуникационная форма для контактного пункта. |
value | ΣC | 1..1 | string | Актуальная информация о контактном точке |
address | Σ | 1..1 | Address | Адрес |
Slices for extension | 0..1 | Extension | Extension Slice: Unordered, Open by value:url | |
codeSDATO | S | 0..1 | string | Код СОАТО URL: https://fhir.by/StructureDefinition/CodeSDATO |
text | Σ | 0..1 | string | Текстовое представление адреса Example General: 220099, Минск, пр-т Победителей, 2, корп. 3, кв. 40 |
line | Σ | 1..1 | string | Название улицы, номер дома/строения, корпус, номер квартиры/помещения, номер абонентского ящика и прочее. This repeating element order: Порядок, в котором строки должны появляться в адресной метке Example General: пр-т Победителей, 2, корп. 3, кв. 40 |
postalCode | Σ | 1..1 | string | Почтовый индекс Example General: 220099 |
period | Σ | 0..1 | Period | Период, в течение которого этот контакт был действителен для использования |
partOf | Σ | 0..1 | Reference(Organization) | Частью какой организации является |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-type from the FHIR Standard | |
Organization.type.coding.code | required | VSTypeOfOrganization (a valid code from Тип медицинской организации)https://fhir.by/ValueSet/VSTypeOfOrganization from this IG | |
Organization.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Organization.qualification.code | example |
Id | Grade | Path(s) | Details | Requirements |
identifierRuleForOKPO | error | Organization | Правило для регистрационного номера ОКПО - 12 цифр : identifier.value.matches('^[0-9]{12}$') | |
identifierRuleForUNP | error | Organization | Правило для УНП - 9 цифр : extension('https://fhir.by/StructureDefinition/CodeUNP').value.matches('^[0-9]{9}$') |
Профиль ресурса: Organization
Summary
Mandatory: 19 elements(3 nested mandatory elements)
Must-Support: 10 elements
Prohibited: 38 elements
Extensions
This structure refers to these extensions:
Существует два места для размещения контактной информации: одно для самой организации и одно или более с использованием конструкции Contact Entity. Первое место предназначено для общественного контакта организации. ContactEntity предназначен для связи с лицом или стороной, с которыми организация назначила контакт для достижения определенной цели.
Метод получения осуществляет доступ к текущему содержимому ресурса. Взаимодействие осуществляется с помощью HTTP GET
команды:
GET [base]/Organization/[id]
Метод возвращает один экземпляр ресурса.
Возможные значения логического идентификатора («id») описаны в типе Id
При попытке доступа к несуществующему ресурсу будет возвращен HTTP статус код - 404 Not Found
Во всех поисковых взаимодействиях в этом руководстве используется HTTP GET
команда со следующим синтаксисом:
GET [base]/[Resource-type]?[parameter1]{:m1|m2|...}={c1|c2|...}[value1{,value2,...}]{&[parameter2]{:m1|m2|...}={c1|c2|...}[value1{,value2,...}]&...}
GET — это HTTP метод, используемый для получения ресурса.
Переменные указанные в «[]», обязательны для предоставления клиентом и будут заменены указанным строковым литералом.
Переменные указанные в «{}», не являются обязательными для предоставления клиентом и будут заменены указанным строковым литералом.
base: URL-адрес сервера
Resource-type: имя типа ресурса (например, “Organization”).
parameter: параметры поиска, определенные для конкретного взаимодействия (например, «?Organization=Organization/01»).
value: значение параметра поиска
: модификатор параметра поиска
{c1 c2 …}: компаратор параметра поиска
{,value2,…}: логическое ИЛИ
{¶meter2={:m1 m2 …}={c1 c2 …}[value1{,value2,…}]&…}: логическое И
Простой пример запроса поиска в RESTful с использованием HTTP GET
команды:
GET [base]/Organization?id=value&...
Параметр поиска | Тип | Описание | Выражение | Пример |
---|---|---|---|---|
_id | token | По логическому идентификатору | Organization.id | GET [base]/Organization?_id=123456 |
_profile | reference | По профилю организации | Organization.meta.profile | GET [base]/Organization?_profile=OrganizationBy |
identifier | token | По идентификатору организации | Organization.identifier | GET [base]/Organization?identifier=0001 |
active | token | Активна ли запись об организации | Organization.active | GET [base]/Organization?active=true |
address | string | Определенный сервером поиск, который может соответствовать любому из строковых полей адреса, включая строку, город, район, штат, страну, почтовый индекс и/или текст | Organization.contact.address | GET [base]/Organization?address=Minsk |
address-city | string | Город, указанный в адресе | Organization.contact.address.city | GET [base]/Organization?address-city=Minsk |
address-country | string | Страна, указанная в адресе | Organization.contact.address.country | GET [base]/Organization?address-country=Minsk |
address-postalcode | string | Почтовый индекс, указанный в адресе | Organization.contact.address.postalCode | GET [base]/Organization?address-postalcode=220022 |
address-state | string | Состояние, указанное в адресе | Organization.contact.address.state | GET [base]/Organization?address-state=Minskaya |
address-use | token | Код использования, указанный в адресе | Organization.contact.address.use | GET [base]/Organization?address-use=official |
endpoint | reference | Технические конечные точки, обеспечивающие доступ к сервисам, предоставляемым организации | Organization.endpoint(Endpoint) | GET [base]/Organization?endpoint=Endpoint01 |
name | string | Часть названия организации | Organization.name | Organization.alias | GET [base]/Organization?name=HoneyHospital |
partof | reference | Организация, частью которой является эта организация | Organization.partOf(Organization) | GET [base]/Organization?partof=HoneyHospital |
phonetic | string | Часть названия организации, использующая какой-то алгоритм фонетического сопоставления | Organization.name | GET [base]/Organization?phonetic=HoniHospital |
type | token | Код, обозначающий тип организации | Organization.type | GET [base]/Organization?type=ambulatory |
GET [base]/Organization?_id=123
- возвращает организации с логическим идентификатором 123
GET [base]/Organization?_id=123,321
- возвращает организации с логическими идентификаторами 123 ИЛИ 321
GET [base]/Organization?_id=123&_id=321
- возвращает пустой список организации - применение логического И в данном случае не имеет смысла, но поддерживается системой
Учитывая, что логический идентификатор уникален, поиск по логическому идентификатору всегда приведет к нулю или единице записей. Во многих отношениях поиск функционально эквивалентен простому методу получения ресурса. Однако есть некоторые различия в использовании поиска вместо чтения:
Операции поиска всегда возвращают ресурс Bundle.
Если логический идентификатор существует и ресурс может быть возвращен, результатом будет Bundle, содержащий ресурс, а не сам ресурс.
Если логический идентификатор не существует или не может быть возвращен, результатом действительного поиска все равно будет Bundle. Bundle МОЖЕТ включать дополнительную информацию в форме OperationOutcome.
Доступен дополнительный функционал поиска. Например, запрос ресурса «Organization» по логическому идентификатору, а также установка критериев поиска identifier вернет организации только в том случае, если идентификатор совпал.
Параметр поиска _profile используется для сопоставления ресурсов на основе значений в элементе Resource.meta.profile
Параметр поиска _profile
определяется как параметр ссылочного типа.
GET [base]/Organization?_profile=http://hl7.org/fhir/StructureDefinition/bp
НЕ допускается использование ТОЛЬКО параметра поиска _profile
, ДОЛЖЕН использоваться ТОЛЬКО в комбинации с каким-либо другим параметром поиска (_id, name)
Параметр поиска name
определяется как параметр типа string.
Параметр поиска по названию в случае с ресурсом Organization ограничивается использованием поиска организации ТОЛЬКО по полному совпадению названию. НЕ ДОПУСКАЕТСЯ использование каких либо компараторов или модификаторов поиска.
Примеры поиска по названию:
GET [base]/Organization?name=Учреждение здравоохранения Поликлиника №1
- возвращает организации с названию Учреждение здравоохранения Поликлиника №1
GET [base]/Organization?name=Учреждение здравоохранения Поликлиника №1,Учреждение здравоохранения Поликлиника №2
- возвращает организации с названию Учреждение здравоохранения Поликлиника №1 ИЛИ Учреждение здравоохранения Поликлиника №2
GET [base]/Organization?name=Учреждение здравоохранения Поликлиника №1&name=Учреждение здравоохранения Поликлиника №2
- возвращает организации с названию Учреждение здравоохранения Поликлиника №1 И Учреждение здравоохранения Поликлиника №2
Параметр поиска identifier
определяется как параметр типа token.
Примеры поиска по идентификатору:
GET [base]/Organization?identifier=123456789012
- возвращает организации у которых идентификатор любого типа равен 123456789012