Руководство к использованию стандарта 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/RelatedPersonPermanentBy Version: 0.1.1667
Active as of 2024-09-16 Имя: RelatedPersonPermanentBy

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

Описание профиля:

Профиль предназначен для записи информации о законном представителе пациента.

Профиль содержит такую информацию, как идентификатор законного представителя пациента, взаимоотношение пациента и его законного представителя, информацию о персональных данных пациента (такие как фамилия, имя и отчество (при наличии), телефон для связи, пол, дата рождения и адрес), а также информацию о периоде действия представления интересов пациента (если он ограничен).

Данный профиль может применяться для записи информации о:

  • физическом лице: близком родственнике, супруге(и), опекуне, контактном лице, указанном пациентом, и лице, которому пациент согласился передавать информацию, составляющую врачебную тайну;
  • представителе юридического лица, который является законным представителем пациента (например, лице, осуществляющем опеку над пациентом).

Usage:

Контент профиля

Описание профилей и принципов работы различных представлений..

Профиль ресурса: RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* RelatedPerson Лицо, представляющее интересы пациента, но не являющееся непосредственным объектом оказания медицинской помощи
PersonPassportRBNumberRule: Номер паспорта должен состоять из двух латинских букв и семи цифр и идентификатор 'Passport' должен содержать расширение 'Место и дата выдачи документа'
... 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/RelatedPersonPermanentBy
.... security 0..0
.... tag 0..0
... implicitRules 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... Slices for identifier 0..* Identifier Идентификатор для этого человека
Slice: Unordered, Closed by value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
.... identifier:PersonIdentifier S 0..1 Identifier Идентификационныей номер
..... id 0..0
..... extension 0..1 Extension Extension
..... Slices for extension Content/Rules for all slices
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... type 1..1 CodeableConcept Описание идентификатора
...... id 0..0
...... extension 0..0
...... coding
....... id 0..0
....... extension 0..0
....... system 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... code 1..1 code Код в синтаксисе, определенном системой
Required Pattern: INP
....... userSelected 0..0
..... system 0..0
..... value 1..1 string Уникальное значение
..... period
...... id 0..0
...... extension 0..0
...... start 1..1 dateTime Начало периода действия
.... identifier:Passport S 0..1 Identifier Паспорт РБ
..... id 0..0
..... extension 0..1 Extension Extension
..... Slices for extension Content/Rules for all slices
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... type 1..1 CodeableConcept Описание идентификатора
...... id 0..0
...... extension 0..0
...... coding
....... id 0..0
....... extension 0..0
....... system 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... code 1..1 code Код в синтаксисе, определенном системой
Required Pattern: Passport-RB
....... userSelected 0..0
..... system 0..0
..... value 1..1 string Уникальное значение
..... period
...... id 0..0
...... extension 0..0
...... start 1..1 dateTime Начало периода действия
.... identifier:DisabilityCertificate S 0..1 Identifier Удостоверение инвалида
..... id 0..0
..... extension 0..1 Extension Extension
..... Slices for extension Content/Rules for all slices
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... type 1..1 CodeableConcept Описание идентификатора
...... id 0..0
...... extension 0..0
...... coding
....... id 0..0
....... extension 0..0
....... system 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... code 1..1 code Код в синтаксисе, определенном системой
Required Pattern: CDP
....... userSelected 0..0
..... system 0..0
..... value 1..1 string Уникальное значение
..... period
...... id 0..0
...... extension 0..0
...... start 1..1 dateTime Начало периода действия
.... identifier:ForeignDocumentNumber S 0..1 Identifier Номер иностранного документа подтверждающего личность
..... id 0..0
..... extension 0..1 Extension Extension
..... Slices for extension Content/Rules for all slices
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... type 1..1 CodeableConcept Описание идентификатора
...... id 0..0
...... extension 0..0
...... coding
....... id 0..0
....... extension 0..0
....... system 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... code 1..1 code Код в синтаксисе, определенном системой
Required Pattern: FDN
....... userSelected 0..0
..... system 0..0
..... value 1..1 string Уникальное значение
..... period
...... id 0..0
...... extension 0..0
...... start 1..1 dateTime Начало периода действия
... active S 1..1 boolean Активно ли используется запись этого связанного лица
... patient S 1..1 Reference(Пациент | Пациент без ИН) Пациент, с которым этот человек состоит в родстве или является контактным лицом
... relationship 1..1 CodeableConcept Отношение к пациенту
.... id 0..0
.... extension 0..0
.... coding
..... id 0..0
..... extension 0..0
..... system 1..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSRelatedPersonType
..... code S 1..1 code Код в синтаксисе, определенном системой
Binding: Набор значений для видов законных представителейя (required)
..... userSelected 0..0
... name S 1..1 HumanName Имя, связанное с этим человеком
.... id 0..0
.... extension 0..0
.... use 0..0
.... family S 1..1 string Фамилия
.... given S 1..* string Имя, отчество
.... prefix 0..0
.... suffix 0..0
.... period 0..0
... telecom S 0..* ContactPoint Контактная информация для этого человека
.... id 0..0
.... extension 0..0
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string Актуальная информация о контактном точке
.... use S 0..1 code home | work | temp | old | mobile - назначение этой контактной точки
.... rank 0..0
.... period 0..0
... gender S 1..1 code male | female | other | unknown
... birthDate S 0..1 date Дата рождения
... address S 0..* Address Адрес
.... id 0..0
.... extension 0..0
.... line 0..1 string Название улицы, номер дома/строения, корпус, номер квартиры/помещения, номер абонентского ящика и прочее.
.... city 1..1 string Название населенного пункта.
.... state 1..1 string Название области
.... country 1..1 string Страна (например, это может быть двух- или трехбуквенный код ISO 3166)
.... period
..... id 0..0
..... extension 0..0
..... start 1..1 dateTime Начало периода действия
... photo 0..0
... period
.... id 0..0
.... extension 0..0
.... start 1..1 dateTime Начало периода действия
... communication 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationship.coding.coderequiredVSRelatedPersonType (a valid code from Виды законных представителей)
https://fhir.by/ValueSet/VSRelatedPersonType
from this IG

Constraints

IdGradePath(s)DetailsRequirements
PersonPassportRBNumberRuleerrorRelatedPersonНомер паспорта должен состоять из двух латинских букв и семи цифр и идентификатор 'Passport' должен содержать расширение 'Место и дата выдачи документа'
: identifier.where(type.coding.code = 'Passport-RB').exists() implies (identifier.where(type.coding.code = 'Passport-RB').value.matches('^[a-zA-Z]{2}[0-9]{7}$') and identifier.where(type.coding.code = 'Passport-RB').extension('https://fhir.by/StructureDefinition/PassportIssued').exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* RelatedPerson Лицо, представляющее интересы пациента, но не являющееся непосредственным объектом оказания медицинской помощи
PersonPassportRBNumberRule: Номер паспорта должен состоять из двух латинских букв и семи цифр и идентификатор 'Passport' должен содержать расширение 'Место и дата выдачи документа'
... id Σ 1..1 id Логический идентификатор этого артефакта
... meta Σ 1..1 Meta Метаданные о ресурсе
.... extension 0..0
.... profile Σ 1..1 canonical(StructureDefinition) Профили, которым, как утверждается, соответствует этот ресурс

Required Pattern: https://fhir.by/StructureDefinition/RelatedPersonPermanentBy
... text 0..1 Narrative Краткое изложение текста ресурса для интерпретации человеком
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 id Уникальный идентификатор для межэлементных ссылок
..... Slices for extension 0..* Extension Дополнительный контент, определяемый реализациями
Slice: Unordered, Open by value:url
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (Если известно)
Binding: IdentifierUse (required): Определяет назначение этого идентификатора, если оно известно.

..... type Σ 0..1 CodeableConcept Описание идентификатора
Binding: IdentifierTypeCodes (extensible): Кодированный тип идентификатора, который может быть использован для определения того, какой идентификатор следует использовать для определенной цели..

..... system Σ 0..1 uri Пространство имен для значения идентификатора
Example General: http://www.acme.com/identifiers/patient
..... value ΣC 0..1 string Уникальное значение
Example General: 123456
..... period Σ 0..1 Period Период времени, в течение которого идентификатор действителен для использования
..... assigner Σ 0..1 Reference(Organization) Организация, выдавшая идентификатор (может быть просто текстом)
.... identifier:PersonIdentifier SΣ 0..1 Identifier Идентификационныей номер
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (Если известно)
Binding: IdentifierUse (required): Определяет назначение этого идентификатора, если оно известно.

..... type Σ 1..1 CodeableConcept Описание идентификатора
Binding: IdentifierTypeCodes (extensible): Кодированный тип идентификатора, который может быть использован для определения того, какой идентификатор следует использовать для определенной цели..

...... extension 0..0
...... coding Σ 0..* Coding Код, определенный терминологической системой
....... extension 0..0
....... system Σ 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... version Σ 0..1 string Версия системы - если это уместно
....... code ΣC 1..1 code Код в синтаксисе, определенном системой
Required Pattern: INP
....... display ΣC 0..1 string Представление, определяемое системой
...... text Σ 0..1 string Простое текстовое представление концепции
..... value ΣC 1..1 string Уникальное значение
Example General: 123456
..... period Σ 0..1 Period Период времени, в течение которого идентификатор действителен для использования
...... extension 0..0
...... start ΣC 1..1 dateTime Начало периода действия
...... end ΣC 0..1 dateTime Конец периода действия
..... assigner Σ 0..1 Reference(Organization) Организация, выдавшая идентификатор (может быть просто текстом)
.... identifier:Passport SΣ 0..1 Identifier Паспорт РБ
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (Если известно)
Binding: IdentifierUse (required): Определяет назначение этого идентификатора, если оно известно.

..... type Σ 1..1 CodeableConcept Описание идентификатора
Binding: IdentifierTypeCodes (extensible): Кодированный тип идентификатора, который может быть использован для определения того, какой идентификатор следует использовать для определенной цели..

...... extension 0..0
...... coding Σ 0..* Coding Код, определенный терминологической системой
....... extension 0..0
....... system Σ 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... version Σ 0..1 string Версия системы - если это уместно
....... code ΣC 1..1 code Код в синтаксисе, определенном системой
Required Pattern: Passport-RB
....... display ΣC 0..1 string Представление, определяемое системой
...... text Σ 0..1 string Простое текстовое представление концепции
..... value ΣC 1..1 string Уникальное значение
Example General: 123456
..... period Σ 0..1 Period Период времени, в течение которого идентификатор действителен для использования
...... extension 0..0
...... start ΣC 1..1 dateTime Начало периода действия
...... end ΣC 0..1 dateTime Конец периода действия
..... assigner Σ 0..1 Reference(Organization) Организация, выдавшая идентификатор (может быть просто текстом)
.... identifier:DisabilityCertificate SΣ 0..1 Identifier Удостоверение инвалида
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (Если известно)
Binding: IdentifierUse (required): Определяет назначение этого идентификатора, если оно известно.

..... type Σ 1..1 CodeableConcept Описание идентификатора
Binding: IdentifierTypeCodes (extensible): Кодированный тип идентификатора, который может быть использован для определения того, какой идентификатор следует использовать для определенной цели..

...... extension 0..0
...... coding Σ 0..* Coding Код, определенный терминологической системой
....... extension 0..0
....... system Σ 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... version Σ 0..1 string Версия системы - если это уместно
....... code ΣC 1..1 code Код в синтаксисе, определенном системой
Required Pattern: CDP
....... display ΣC 0..1 string Представление, определяемое системой
...... text Σ 0..1 string Простое текстовое представление концепции
..... value ΣC 1..1 string Уникальное значение
Example General: 123456
..... period Σ 0..1 Period Период времени, в течение которого идентификатор действителен для использования
...... extension 0..0
...... start ΣC 1..1 dateTime Начало периода действия
...... end ΣC 0..1 dateTime Конец периода действия
..... assigner Σ 0..1 Reference(Organization) Организация, выдавшая идентификатор (может быть просто текстом)
.... identifier:ForeignDocumentNumber SΣ 0..1 Identifier Номер иностранного документа подтверждающего личность
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (Если известно)
Binding: IdentifierUse (required): Определяет назначение этого идентификатора, если оно известно.

..... type Σ 1..1 CodeableConcept Описание идентификатора
Binding: IdentifierTypeCodes (extensible): Кодированный тип идентификатора, который может быть использован для определения того, какой идентификатор следует использовать для определенной цели..

...... extension 0..0
...... coding Σ 0..* Coding Код, определенный терминологической системой
....... extension 0..0
....... system Σ 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... version Σ 0..1 string Версия системы - если это уместно
....... code ΣC 1..1 code Код в синтаксисе, определенном системой
Required Pattern: FDN
....... display ΣC 0..1 string Представление, определяемое системой
...... text Σ 0..1 string Простое текстовое представление концепции
..... value ΣC 1..1 string Уникальное значение
Example General: 123456
..... period Σ 0..1 Period Период времени, в течение которого идентификатор действителен для использования
...... extension 0..0
...... start ΣC 1..1 dateTime Начало периода действия
...... end ΣC 0..1 dateTime Конец периода действия
..... assigner Σ 0..1 Reference(Organization) Организация, выдавшая идентификатор (может быть просто текстом)
... active ?!SΣ 1..1 boolean Активно ли используется запись этого связанного лица
... patient SΣ 1..1 Reference(Пациент | Пациент без ИН) Пациент, с которым этот человек состоит в родстве или является контактным лицом
... relationship Σ 1..1 CodeableConcept Отношение к пациенту
Binding: PatientRelationshipType (preferred): Характер отношений между пациентом и связанным с ним лицом.


.... extension 0..0
.... coding Σ 0..* Coding Код, определенный терминологической системой
..... extension 0..0
..... system Σ 1..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSRelatedPersonType
..... version Σ 0..1 string Версия системы - если это уместно
..... code SΣC 1..1 code Код в синтаксисе, определенном системой
Binding: Набор значений для видов законных представителейя (required)
..... display ΣC 0..1 string Представление, определяемое системой
.... text Σ 0..1 string Простое текстовое представление концепции
... name SΣ 1..1 HumanName Имя, связанное с этим человеком
.... extension 0..0
.... text Σ 0..1 string Текстовое представление полного имени
.... family SΣ 1..1 string Фамилия
.... given SΣ 1..* string Имя, отчество
This repeating element order: Имена указаны в правильном порядке представления имени
... telecom SΣ 0..* ContactPoint Контактная информация для этого человека
.... extension 0..0
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Телекоммуникационная форма для контактного пункта.

.... value SΣC 1..1 string Актуальная информация о контактном точке
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - назначение этой контактной точки
Binding: ContactPointUse (required): Использование этой контактной точки.

... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): Пол человека, используемого в административных целях.

... birthDate SΣ 0..1 date Дата рождения
... address SΣ 0..* Address Адрес
.... extension 0..0
.... use ?!Σ 0..1 code home | work | temp | old | billing - назначение этого адреса
Binding: AddressUse (required): Использование адреса (home / work / etc.).


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): Тип адреса (физический / почтовый).


Example General: both
.... text Σ 0..1 string Текстовое представление адреса
Example General: 220099, Минск, пр-т Победителей, 2, корп. 3, кв. 40
.... line Σ 0..1 string Название улицы, номер дома/строения, корпус, номер квартиры/помещения, номер абонентского ящика и прочее.
This repeating element order: Порядок, в котором строки должны появляться в адресной метке
Example General: пр-т Победителей, 2, корп. 3, кв. 40
.... city Σ 1..1 string Название населенного пункта.
Example General: Минск
.... district Σ 0..1 string Название района
Example General: Минский район
.... state Σ 1..1 string Название области
.... postalCode Σ 0..1 string Почтовый индекс
Example General: 220099
.... country Σ 1..1 string Страна (например, это может быть двух- или трехбуквенный код ISO 3166)
.... period Σ 0..1 Period Период времени, когда адрес использовался/используется
Example General: {"start":"2010-03-23","end":"2010-07-01"}
..... extension 0..0
..... start ΣC 1..1 dateTime Начало периода действия
..... end ΣC 0..1 dateTime Конец периода действия
... period 0..1 Period Период времени, в течение которого эти отношения считаются действительными
.... extension 0..0
.... start ΣC 1..1 dateTime Начало периода действия
.... end ΣC 0..1 dateTime Конец периода действия

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.identifier:PersonIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.identifier:PersonIdentifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.identifier:Passport.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.identifier:Passport.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.identifier:DisabilityCertificate.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.identifier:DisabilityCertificate.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.identifier:ForeignDocumentNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.identifier:ForeignDocumentNumber.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.relationshippreferredPatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.relationship.coding.coderequiredVSRelatedPersonType (a valid code from Виды законных представителей)
https://fhir.by/ValueSet/VSRelatedPersonType
from this IG
RelatedPerson.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
RelatedPerson.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
from the FHIR Standard
RelatedPerson.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard
RelatedPerson.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|5.0.0
from the FHIR Standard
RelatedPerson.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
PersonPassportRBNumberRuleerrorRelatedPersonНомер паспорта должен состоять из двух латинских букв и семи цифр и идентификатор 'Passport' должен содержать расширение 'Место и дата выдачи документа'
: identifier.where(type.coding.code = 'Passport-RB').exists() implies (identifier.where(type.coding.code = 'Passport-RB').value.matches('^[a-zA-Z]{2}[0-9]{7}$') and identifier.where(type.coding.code = 'Passport-RB').extension('https://fhir.by/StructureDefinition/PassportIssued').exists())

Профиль ресурса: RelatedPerson

Summary

Mandatory: 9 elements(25 nested mandatory elements)
Must-Support: 22 elements
Prohibited: 71 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of RelatedPerson.identifier (Closed)

Схема различий

Профиль ресурса: RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* RelatedPerson Лицо, представляющее интересы пациента, но не являющееся непосредственным объектом оказания медицинской помощи
PersonPassportRBNumberRule: Номер паспорта должен состоять из двух латинских букв и семи цифр и идентификатор 'Passport' должен содержать расширение 'Место и дата выдачи документа'
... 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/RelatedPersonPermanentBy
.... security 0..0
.... tag 0..0
... implicitRules 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... Slices for identifier 0..* Identifier Идентификатор для этого человека
Slice: Unordered, Closed by value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
.... identifier:PersonIdentifier S 0..1 Identifier Идентификационныей номер
..... id 0..0
..... extension 0..1 Extension Extension
..... Slices for extension Content/Rules for all slices
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... type 1..1 CodeableConcept Описание идентификатора
...... id 0..0
...... extension 0..0
...... coding
....... id 0..0
....... extension 0..0
....... system 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... code 1..1 code Код в синтаксисе, определенном системой
Required Pattern: INP
....... userSelected 0..0
..... system 0..0
..... value 1..1 string Уникальное значение
..... period
...... id 0..0
...... extension 0..0
...... start 1..1 dateTime Начало периода действия
.... identifier:Passport S 0..1 Identifier Паспорт РБ
..... id 0..0
..... extension 0..1 Extension Extension
..... Slices for extension Content/Rules for all slices
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... type 1..1 CodeableConcept Описание идентификатора
...... id 0..0
...... extension 0..0
...... coding
....... id 0..0
....... extension 0..0
....... system 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... code 1..1 code Код в синтаксисе, определенном системой
Required Pattern: Passport-RB
....... userSelected 0..0
..... system 0..0
..... value 1..1 string Уникальное значение
..... period
...... id 0..0
...... extension 0..0
...... start 1..1 dateTime Начало периода действия
.... identifier:DisabilityCertificate S 0..1 Identifier Удостоверение инвалида
..... id 0..0
..... extension 0..1 Extension Extension
..... Slices for extension Content/Rules for all slices
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... type 1..1 CodeableConcept Описание идентификатора
...... id 0..0
...... extension 0..0
...... coding
....... id 0..0
....... extension 0..0
....... system 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... code 1..1 code Код в синтаксисе, определенном системой
Required Pattern: CDP
....... userSelected 0..0
..... system 0..0
..... value 1..1 string Уникальное значение
..... period
...... id 0..0
...... extension 0..0
...... start 1..1 dateTime Начало периода действия
.... identifier:ForeignDocumentNumber S 0..1 Identifier Номер иностранного документа подтверждающего личность
..... id 0..0
..... extension 0..1 Extension Extension
..... Slices for extension Content/Rules for all slices
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... type 1..1 CodeableConcept Описание идентификатора
...... id 0..0
...... extension 0..0
...... coding
....... id 0..0
....... extension 0..0
....... system 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... code 1..1 code Код в синтаксисе, определенном системой
Required Pattern: FDN
....... userSelected 0..0
..... system 0..0
..... value 1..1 string Уникальное значение
..... period
...... id 0..0
...... extension 0..0
...... start 1..1 dateTime Начало периода действия
... active S 1..1 boolean Активно ли используется запись этого связанного лица
... patient S 1..1 Reference(Пациент | Пациент без ИН) Пациент, с которым этот человек состоит в родстве или является контактным лицом
... relationship 1..1 CodeableConcept Отношение к пациенту
.... id 0..0
.... extension 0..0
.... coding
..... id 0..0
..... extension 0..0
..... system 1..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSRelatedPersonType
..... code S 1..1 code Код в синтаксисе, определенном системой
Binding: Набор значений для видов законных представителейя (required)
..... userSelected 0..0
... name S 1..1 HumanName Имя, связанное с этим человеком
.... id 0..0
.... extension 0..0
.... use 0..0
.... family S 1..1 string Фамилия
.... given S 1..* string Имя, отчество
.... prefix 0..0
.... suffix 0..0
.... period 0..0
... telecom S 0..* ContactPoint Контактная информация для этого человека
.... id 0..0
.... extension 0..0
.... system S 1..1 code phone | fax | email | pager | url | sms | other
.... value S 1..1 string Актуальная информация о контактном точке
.... use S 0..1 code home | work | temp | old | mobile - назначение этой контактной точки
.... rank 0..0
.... period 0..0
... gender S 1..1 code male | female | other | unknown
... birthDate S 0..1 date Дата рождения
... address S 0..* Address Адрес
.... id 0..0
.... extension 0..0
.... line 0..1 string Название улицы, номер дома/строения, корпус, номер квартиры/помещения, номер абонентского ящика и прочее.
.... city 1..1 string Название населенного пункта.
.... state 1..1 string Название области
.... country 1..1 string Страна (например, это может быть двух- или трехбуквенный код ISO 3166)
.... period
..... id 0..0
..... extension 0..0
..... start 1..1 dateTime Начало периода действия
... photo 0..0
... period
.... id 0..0
.... extension 0..0
.... start 1..1 dateTime Начало периода действия
... communication 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationship.coding.coderequiredVSRelatedPersonType (a valid code from Виды законных представителей)
https://fhir.by/ValueSet/VSRelatedPersonType
from this IG

Constraints

IdGradePath(s)DetailsRequirements
PersonPassportRBNumberRuleerrorRelatedPersonНомер паспорта должен состоять из двух латинских букв и семи цифр и идентификатор 'Passport' должен содержать расширение 'Место и дата выдачи документа'
: identifier.where(type.coding.code = 'Passport-RB').exists() implies (identifier.where(type.coding.code = 'Passport-RB').value.matches('^[a-zA-Z]{2}[0-9]{7}$') and identifier.where(type.coding.code = 'Passport-RB').extension('https://fhir.by/StructureDefinition/PassportIssued').exists())

Полная Схема

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C 0..* RelatedPerson Лицо, представляющее интересы пациента, но не являющееся непосредственным объектом оказания медицинской помощи
PersonPassportRBNumberRule: Номер паспорта должен состоять из двух латинских букв и семи цифр и идентификатор 'Passport' должен содержать расширение 'Место и дата выдачи документа'
... id Σ 1..1 id Логический идентификатор этого артефакта
... meta Σ 1..1 Meta Метаданные о ресурсе
.... extension 0..0
.... profile Σ 1..1 canonical(StructureDefinition) Профили, которым, как утверждается, соответствует этот ресурс

Required Pattern: https://fhir.by/StructureDefinition/RelatedPersonPermanentBy
... text 0..1 Narrative Краткое изложение текста ресурса для интерпретации человеком
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 id Уникальный идентификатор для межэлементных ссылок
..... Slices for extension 0..* Extension Дополнительный контент, определяемый реализациями
Slice: Unordered, Open by value:url
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (Если известно)
Binding: IdentifierUse (required): Определяет назначение этого идентификатора, если оно известно.

..... type Σ 0..1 CodeableConcept Описание идентификатора
Binding: IdentifierTypeCodes (extensible): Кодированный тип идентификатора, который может быть использован для определения того, какой идентификатор следует использовать для определенной цели..

..... system Σ 0..1 uri Пространство имен для значения идентификатора
Example General: http://www.acme.com/identifiers/patient
..... value ΣC 0..1 string Уникальное значение
Example General: 123456
..... period Σ 0..1 Period Период времени, в течение которого идентификатор действителен для использования
..... assigner Σ 0..1 Reference(Organization) Организация, выдавшая идентификатор (может быть просто текстом)
.... identifier:PersonIdentifier SΣ 0..1 Identifier Идентификационныей номер
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (Если известно)
Binding: IdentifierUse (required): Определяет назначение этого идентификатора, если оно известно.

..... type Σ 1..1 CodeableConcept Описание идентификатора
Binding: IdentifierTypeCodes (extensible): Кодированный тип идентификатора, который может быть использован для определения того, какой идентификатор следует использовать для определенной цели..

...... extension 0..0
...... coding Σ 0..* Coding Код, определенный терминологической системой
....... extension 0..0
....... system Σ 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... version Σ 0..1 string Версия системы - если это уместно
....... code ΣC 1..1 code Код в синтаксисе, определенном системой
Required Pattern: INP
....... display ΣC 0..1 string Представление, определяемое системой
...... text Σ 0..1 string Простое текстовое представление концепции
..... value ΣC 1..1 string Уникальное значение
Example General: 123456
..... period Σ 0..1 Period Период времени, в течение которого идентификатор действителен для использования
...... extension 0..0
...... start ΣC 1..1 dateTime Начало периода действия
...... end ΣC 0..1 dateTime Конец периода действия
..... assigner Σ 0..1 Reference(Organization) Организация, выдавшая идентификатор (может быть просто текстом)
.... identifier:Passport SΣ 0..1 Identifier Паспорт РБ
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (Если известно)
Binding: IdentifierUse (required): Определяет назначение этого идентификатора, если оно известно.

..... type Σ 1..1 CodeableConcept Описание идентификатора
Binding: IdentifierTypeCodes (extensible): Кодированный тип идентификатора, который может быть использован для определения того, какой идентификатор следует использовать для определенной цели..

...... extension 0..0
...... coding Σ 0..* Coding Код, определенный терминологической системой
....... extension 0..0
....... system Σ 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... version Σ 0..1 string Версия системы - если это уместно
....... code ΣC 1..1 code Код в синтаксисе, определенном системой
Required Pattern: Passport-RB
....... display ΣC 0..1 string Представление, определяемое системой
...... text Σ 0..1 string Простое текстовое представление концепции
..... value ΣC 1..1 string Уникальное значение
Example General: 123456
..... period Σ 0..1 Period Период времени, в течение которого идентификатор действителен для использования
...... extension 0..0
...... start ΣC 1..1 dateTime Начало периода действия
...... end ΣC 0..1 dateTime Конец периода действия
..... assigner Σ 0..1 Reference(Organization) Организация, выдавшая идентификатор (может быть просто текстом)
.... identifier:DisabilityCertificate SΣ 0..1 Identifier Удостоверение инвалида
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (Если известно)
Binding: IdentifierUse (required): Определяет назначение этого идентификатора, если оно известно.

..... type Σ 1..1 CodeableConcept Описание идентификатора
Binding: IdentifierTypeCodes (extensible): Кодированный тип идентификатора, который может быть использован для определения того, какой идентификатор следует использовать для определенной цели..

...... extension 0..0
...... coding Σ 0..* Coding Код, определенный терминологической системой
....... extension 0..0
....... system Σ 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... version Σ 0..1 string Версия системы - если это уместно
....... code ΣC 1..1 code Код в синтаксисе, определенном системой
Required Pattern: CDP
....... display ΣC 0..1 string Представление, определяемое системой
...... text Σ 0..1 string Простое текстовое представление концепции
..... value ΣC 1..1 string Уникальное значение
Example General: 123456
..... period Σ 0..1 Period Период времени, в течение которого идентификатор действителен для использования
...... extension 0..0
...... start ΣC 1..1 dateTime Начало периода действия
...... end ΣC 0..1 dateTime Конец периода действия
..... assigner Σ 0..1 Reference(Organization) Организация, выдавшая идентификатор (может быть просто текстом)
.... identifier:ForeignDocumentNumber SΣ 0..1 Identifier Номер иностранного документа подтверждающего личность
..... Slices for extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
...... passportIssued S 0..1 string Место и дата выдачи документа
URL: https://fhir.by/StructureDefinition/PassportIssued
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (Если известно)
Binding: IdentifierUse (required): Определяет назначение этого идентификатора, если оно известно.

..... type Σ 1..1 CodeableConcept Описание идентификатора
Binding: IdentifierTypeCodes (extensible): Кодированный тип идентификатора, который может быть использован для определения того, какой идентификатор следует использовать для определенной цели..

...... extension 0..0
...... coding Σ 0..* Coding Код, определенный терминологической системой
....... extension 0..0
....... system Σ 0..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSDocNumbersBy
....... version Σ 0..1 string Версия системы - если это уместно
....... code ΣC 1..1 code Код в синтаксисе, определенном системой
Required Pattern: FDN
....... display ΣC 0..1 string Представление, определяемое системой
...... text Σ 0..1 string Простое текстовое представление концепции
..... value ΣC 1..1 string Уникальное значение
Example General: 123456
..... period Σ 0..1 Period Период времени, в течение которого идентификатор действителен для использования
...... extension 0..0
...... start ΣC 1..1 dateTime Начало периода действия
...... end ΣC 0..1 dateTime Конец периода действия
..... assigner Σ 0..1 Reference(Organization) Организация, выдавшая идентификатор (может быть просто текстом)
... active ?!SΣ 1..1 boolean Активно ли используется запись этого связанного лица
... patient SΣ 1..1 Reference(Пациент | Пациент без ИН) Пациент, с которым этот человек состоит в родстве или является контактным лицом
... relationship Σ 1..1 CodeableConcept Отношение к пациенту
Binding: PatientRelationshipType (preferred): Характер отношений между пациентом и связанным с ним лицом.


.... extension 0..0
.... coding Σ 0..* Coding Код, определенный терминологической системой
..... extension 0..0
..... system Σ 1..1 uri Идентичность терминологической системы
Required Pattern: https://fhir.by/CodeSystem/CSRelatedPersonType
..... version Σ 0..1 string Версия системы - если это уместно
..... code SΣC 1..1 code Код в синтаксисе, определенном системой
Binding: Набор значений для видов законных представителейя (required)
..... display ΣC 0..1 string Представление, определяемое системой
.... text Σ 0..1 string Простое текстовое представление концепции
... name SΣ 1..1 HumanName Имя, связанное с этим человеком
.... extension 0..0
.... text Σ 0..1 string Текстовое представление полного имени
.... family SΣ 1..1 string Фамилия
.... given SΣ 1..* string Имя, отчество
This repeating element order: Имена указаны в правильном порядке представления имени
... telecom SΣ 0..* ContactPoint Контактная информация для этого человека
.... extension 0..0
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Телекоммуникационная форма для контактного пункта.

.... value SΣC 1..1 string Актуальная информация о контактном точке
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - назначение этой контактной точки
Binding: ContactPointUse (required): Использование этой контактной точки.

... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): Пол человека, используемого в административных целях.

... birthDate SΣ 0..1 date Дата рождения
... address SΣ 0..* Address Адрес
.... extension 0..0
.... use ?!Σ 0..1 code home | work | temp | old | billing - назначение этого адреса
Binding: AddressUse (required): Использование адреса (home / work / etc.).


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): Тип адреса (физический / почтовый).


Example General: both
.... text Σ 0..1 string Текстовое представление адреса
Example General: 220099, Минск, пр-т Победителей, 2, корп. 3, кв. 40
.... line Σ 0..1 string Название улицы, номер дома/строения, корпус, номер квартиры/помещения, номер абонентского ящика и прочее.
This repeating element order: Порядок, в котором строки должны появляться в адресной метке
Example General: пр-т Победителей, 2, корп. 3, кв. 40
.... city Σ 1..1 string Название населенного пункта.
Example General: Минск
.... district Σ 0..1 string Название района
Example General: Минский район
.... state Σ 1..1 string Название области
.... postalCode Σ 0..1 string Почтовый индекс
Example General: 220099
.... country Σ 1..1 string Страна (например, это может быть двух- или трехбуквенный код ISO 3166)
.... period Σ 0..1 Period Период времени, когда адрес использовался/используется
Example General: {"start":"2010-03-23","end":"2010-07-01"}
..... extension 0..0
..... start ΣC 1..1 dateTime Начало периода действия
..... end ΣC 0..1 dateTime Конец периода действия
... period 0..1 Period Период времени, в течение которого эти отношения считаются действительными
.... extension 0..0
.... start ΣC 1..1 dateTime Начало периода действия
.... end ΣC 0..1 dateTime Конец периода действия

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.identifier:PersonIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.identifier:PersonIdentifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.identifier:Passport.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.identifier:Passport.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.identifier:DisabilityCertificate.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.identifier:DisabilityCertificate.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.identifier:ForeignDocumentNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
RelatedPerson.identifier:ForeignDocumentNumber.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.relationshippreferredPatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.relationship.coding.coderequiredVSRelatedPersonType (a valid code from Виды законных представителей)
https://fhir.by/ValueSet/VSRelatedPersonType
from this IG
RelatedPerson.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
RelatedPerson.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
from the FHIR Standard
RelatedPerson.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|5.0.0
from the FHIR Standard
RelatedPerson.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|5.0.0
from the FHIR Standard
RelatedPerson.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
PersonPassportRBNumberRuleerrorRelatedPersonНомер паспорта должен состоять из двух латинских букв и семи цифр и идентификатор 'Passport' должен содержать расширение 'Место и дата выдачи документа'
: identifier.where(type.coding.code = 'Passport-RB').exists() implies (identifier.where(type.coding.code = 'Passport-RB').value.matches('^[a-zA-Z]{2}[0-9]{7}$') and identifier.where(type.coding.code = 'Passport-RB').extension('https://fhir.by/StructureDefinition/PassportIssued').exists())

Профиль ресурса: RelatedPerson

Summary

Mandatory: 9 elements(25 nested mandatory elements)
Must-Support: 22 elements
Prohibited: 71 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of RelatedPerson.identifier (Closed)

 


Примечания:

Для элемента identifier.type.coding.code используется используется набор кодов идентификатора представителя пациента

Синтаксис метода получения ресурса

Метод получения осуществляет доступ к текущему содержимому ресурса. Взаимодействие осуществляется с помощью HTTP GET команды:

GET [base]/fhir/Patient/[patientId]/RelatedPerson/[id]

Метод возвращает один экземпляр ресурса.

Возможные значения логического идентификатора («id») описаны в типе Id

При попытке доступа к несуществующему ресурсу будет возвращен HTTP статус код - 404 Not Found

Синтаксис поиска ресурса

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

GET [base]/fhir/Patient/[patientId]/[Resource-type]?[parameter1]{:m1|m2|...}={c1|c2|...}[value1{,value2,...}]{&[parameter2]{:m1|m2|...}={c1|c2|...}[value1{,value2,...}]&...}

  • GET — это HTTP метод, используемый для получения ресурса.

  • Переменные указанные в «[]», обязательны для предоставления клиентом и будут заменены указанным строковым литералом.

  • Переменные указанные в «{}», не являются обязательными для предоставления клиентом и будут заменены указанным строковым литералом.

  • base: URL-адрес сервера

  • Resource-type: имя типа ресурса (например, RelatedPerson).

  • patientId: идентификатор пациента для которого будет производится поиск по связаным лицам.

  • parameter: параметры поиска, определенные для конкретного взаимодействия (например, «?patient=RelatedPerson/123»).

  • value: значение параметра поиска

  • : модификатор параметра поиска

  • {c1 c2 …}: компаратор параметра поиска

  • {,value2,…}: логическое ИЛИ

  • {&parameter2={:m1 m2 …}={c1 c2 …}[value1{,value2,…}&…}: логическое И

Простой пример запроса поиска в RESTful с использованием HTTP GET команды:

GET [base]/fhir/Patient/[patientId]/RelatedPerson?name=value&...

Поддерживаемые параметры поиска ресурса

Параметр поиска Тип Описание Выражение
_id token По логическому идентификатору RelatedPerson.id
_profile reference По профилю пациента RelatedPerson.meta.profile
identifier token По идентификатору пациента RelatedPerson.identifier
birthdate date По дате рождения пациента RelatedPerson.birthDate
name string Поиск по ФИО пациента RelatedPerson.name
address string Поиск, который может соответствовать любому из строковых полей в адресе, включая линию, город, район, штат, страну, почтовый индекс и/или текст. RelatedPerson.address

Поиск по логическому идентификатору

GET [base]/fhir/Patient/[patientId]/RelatedPerson?_id=123- возвращает связанных лиц с логическим идентификатором 123

GET [base]/fhir/Patient/[patientId]/RelatedPerson?_id=123,321- возвращает связанных лиц с логическими идентификаторами 123 ИЛИ 321

GET [base]/fhir/Patient/[patientId]/RelatedPerson?_id=123&_id=321- возвращает пустой список связанных лиц - применение логического И в данном случае не имеет смысла, но поддерживается системой

Учитывая, что логический идентификатор уникален, поиск по логическому идентификатору всегда приведет к нулю или единице записей. Во многих отношениях поиск функционально эквивалентен простому методу получения ресурса. Однако есть некоторые различия в использовании поиска вместо чтения:

  • Операции поиска всегда возвращают ресурс Bundle.

  • Если логический идентификатор существует и ресурс может быть возвращен, результатом будет Bundle, содержащий ресурс, а не сам ресурс.

  • Если логический идентификатор не существует или не может быть возвращен, результатом действительного поиска все равно будет Bundle. Bundle МОЖЕТ включать дополнительную информацию в форме OperationOutcome.

  • Доступен дополнительный функционал поиска. Например, запрос ресурса «Patient» по логическому идентификатору, а также установка критериев поиска birthdate вернет пациента только в том случае, если дата рождения совпала.

Поиск по профилю ресурса.

​Параметр поиска _profile используется для сопоставления ресурсов на основе значений в элементе Resource.meta.profile

Параметр поиска _profile определяется как параметр ссылочного типа.

GET [base]/fhir/Patient/[patientId]/Patient?_profile=http://hl7.org/fhir/StructureDefinition/bp

НЕ допускается использование ТОЛЬКО параметра поиска _profile, ДОЛЖЕН использоваться ТОЛЬКО в комбинации с каким-либо другим параметром поиска (_id, birthdate, address, name)

Поиск по дате рождения.

Параметр поиска birthdate определяется как параметр типа date.

Параметр поиска по дате рождения в случае с ресурсом RelatedPerson ограничивается использованием поиска пациента ТОЛЬКО по полному совпадению даты рождения. НЕ ДОПУСКАЕТСЯ использование каких либо компараторов или модификаторов поиска.

Примеры поиска по дате рождения:

GET [base]/fhir/Patient/[patientId]/RelatedPerson?birthdate=2013-01-14 - возвращает связанных лиц с датой рождения 2013-01-14

GET [base]/fhir/Patient/[patientId]/RelatedPerson?birthdate=2013-01-14,2022-01-14 - возвращает связанных лиц с датой рождения 2013-01-14 ИЛИ 2022-01-14

GET [base]/fhir/Patient/[patientId]/RelatedPerson?birthdate=2013-01-14&birthdate=2022-01-14 - возвращает пустой список связанных лиц - применение логического И в данном случае не имеет смысла, но поддерживается системой

Поиск по ФИО.

Параметр поиска name определяется как параметр типа string.

Параметр поиска по ФИО в случае с ресурсом RelatedPerson ограничивается использованием поиска связанных лиц ТОЛЬКО по полному совпадению ФИО. НЕ ДОПУСКАЕТСЯ использование каких либо компараторов или модификаторов поиска.

Примеры поиска по ФИО:

GET [base]/fhir/Patient/[patientId]/RelatedPerson?name=Иванов Иван Иванович - возвращает связанных лиц с ФИО Иванов Иван Иванович

GET [base]/fhir/Patient/[patientId]/RelatedPerson?name=Иванов Иван Иванович,Петров Петр Петрович - возвращает связанных лиц с ФИО Иванов Иван Иванович ИЛИ Петров Петр Петрович

GET [base]/fhir/Patient/[patientId]/RelatedPerson?name=Иванов Иван Иванович&name=Петров Петр Петрович - возвращает связанных лиц с ФИО Иванов Иван Иванович И Петров Петр Петрович

Поиск по адресу.

Параметр поиска address определяется как параметр типа string.

Поиск охватывает элементы типа string и не охватывает такие элементы, как useи period.

Примеры поиска по адресу:

GET [base]/fhir/Patient/[patientId]/RelatedPerson?address=Минск - возвращает связанных лиц, адрес которых содержит часть со словом «Минск» в начале строки. Сюда войдут связанные лица с адресами «Минск», «Минский».

GET [base]/fhir/Patient/[patientId]/RelatedPerson?address:contains=Минск - возвращает связанных лиц, адрес которых содержит слово «Минск» в любой позиции. Сюда войдут связанные лица с адресами «Минск», «Минский», а также «ИзМинска».

GET [base]/fhir/Patient/[patientId]/RelatedPerson?:exact=Минск - возвращает связанных лиц, адрес которых не соответствует «Минск». Сюда не входят связанные лица с адресами «Минск» или «МИНСК».

Поиск по идентификатору.

Параметр поиска identifier определяется как параметр типа token.

Примеры поиска по идентификатору:

GET [base]/fhir/Patient/[patientId]/RelatedPerson?identifier:of-type=http://fhir.by/CodeSystem/DocNumbersBySystem|INP|446053 - возвращает связанных лиц у которых Идентификационный номер равен 446053

GET [base]/fhir/Patient/[patientId]/RelatedPerson?identifier=446053 - возвращает связанных лиц у которых идентификатор любого типа равен 446053