Руководство к использованию стандарта FHIR в ЦИСЗ
0.1.1660 - ci-build

Руководство к использованию стандарта FHIR в ЦИСЗ - Local Development build (v0.1.1660) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Получение возможностей сервера

Метод предназначен для получения возможностей сервера ЦИСЗ.

Этот метод можно использовать во время проектирования и разработки чтобы извлечь информацию о возможностях сервера — какие части FHIR спецификации он поддерживает.

Этот метод возвращает 200 ОК.

Вызов метода осуществляется с помощью HTTP GET команды:

GET [base]/fhir/metadata

Исходящие параметры метода:

Название Профиль Описание
CapabilityStatement CapabilityStatement Информация о возможностях документирует набор возможностей сервера или клиента FHIR для конкретной версии FHIR

Пример запроса для получения возможностей сервера ЦИСЗ.

{
  "resourceType": "CapabilityStatement",
  "url": "https://localhost:7178/api/Fhir/metadata",
  "name": "fhir.by API модуля обработки персональных данных Capability Statement",
  "status": "draft",
  "experimental": false,
  "date": "2024-06-11T09:14:58.2296134+00:00",
  "publisher": "fhir.by",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://www.fhir.by.com"
        }
      ]
    }
  ],
  "kind": "capability",
  "software": {
    "name": "API модуля обработки персональных данных"
  },
  "fhirVersion": "5.0.0",
  "format": [
    "application/fhir+json",
    "json"
  ],
  "patchFormat": [
    "application/fhir+json",
    "application/json-patch+json"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "type": "Patient",
          "profile": "http://hl7.org/fhir/StructureDefinition/Patient",
          "interaction": [
            {
              "code": "create"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "versioned",
          "readHistory": false,
          "updateCreate": false,
          "conditionalCreate": false,
          "conditionalUpdate": false,
          "conditionalDelete": "single",
          "searchInclude": [
            "Patient:organization",
            "Patient:general-practitioner",
            "*"
          ],
          "searchRevInclude": [
            "RelatedPerson:patient"
          ],
          "searchParam": [
            {
              "name": "address",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address",
              "type": "string",
              "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text"
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
              "type": "token",
              "documentation": "A patient identifier"
            },
            {
              "name": "_lastUpdated",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type": "date",
              "documentation": "When the resource version last changed"
            },
            {
              "name": "birthdate",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
              "type": "date",
              "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth"
            },
            {
              "name": "organization",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-organization",
              "type": "reference",
              "documentation": "The organization that is the custodian of the patient record"
            },
            {
              "name": "general-practitioner",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-general-practitioner",
              "type": "reference",
              "documentation": "Patient's nominated general practitioner, not the organization that manages the record"
            },
            {
              "name": "_profile",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
              "type": "uri",
              "documentation": "Profiles this resource claims to conform to"
            },
            {
              "name": "_source",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
              "type": "uri",
              "documentation": "Identifies where the resource comes from"
            },
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-name",
              "type": "string",
              "documentation": "A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text"
            }
          ]
        },
        {
          "type": "RelatedPerson",
          "profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
          "interaction": [
            {
              "code": "create"
            },
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "versioned",
          "readHistory": false,
          "updateCreate": false,
          "conditionalCreate": false,
          "conditionalUpdate": false,
          "conditionalDelete": "single",
          "searchInclude": [
            "RelatedPerson:patient",
            "*"
          ],
          "searchParam": [
            {
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-patient",
              "type": "reference",
              "documentation": "The patient this related person is related to"
            },
            {
              "name": "address",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address",
              "type": "string",
              "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text"
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-identifier",
              "type": "token",
              "documentation": "An Identifier of the RelatedPerson"
            },
            {
              "name": "_lastUpdated",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type": "date",
              "documentation": "When the resource version last changed"
            },
            {
              "name": "relationship",
              "definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-relationship",
              "type": "token",
              "documentation": "The relationship between the patient and the relatedperson"
            },
            {
              "name": "birthdate",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
              "type": "date",
              "documentation": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient's date of birth\r\n* [Person](person.html): The person's date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person's date of birth"
            },
            {
              "name": "_profile",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-profile",
              "type": "uri",
              "documentation": "Profiles this resource claims to conform to"
            },
            {
              "name": "_source",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
              "type": "uri",
              "documentation": "Identifies where the resource comes from"
            },
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Logical id of this artifact"
            },
            {
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/RelatedPerson-name",
              "type": "string",
              "documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
            }
          ]
        },
        {
          "type": "Organization",
          "profile": "http://hl7.org/fhir/StructureDefinition/Organization",
          "versioning": "versioned",
          "conditionalCreate": false,
          "conditionalUpdate": false,
          "conditionalDelete": "single",
          "searchRevInclude": [
            "Patient:organization",
            "Patient:general-practitioner"
          ]
        },
        {
          "type": "Practitioner",
          "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner",
          "versioning": "versioned",
          "conditionalCreate": false,
          "conditionalUpdate": false,
          "conditionalDelete": "single",
          "searchRevInclude": [
            "Patient:general-practitioner"
          ]
        },
        {
          "type": "PractitionerRole",
          "profile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
          "versioning": "versioned",
          "conditionalCreate": false,
          "conditionalUpdate": false,
          "conditionalDelete": "single",
          "searchRevInclude": [
            "Patient:general-practitioner"
          ]
        }
      ],
      "searchParam": [
        {
          "name": "_type",
          "definition": "http://hl7.org/fhir/SearchParameter/type",
          "type": "token"
        },
        {
          "name": "_count",
          "type": "number"
        }
      ]
    }
  ]
}

Пример в виде postman коллекций

Ссылка Описание
Скачать Переменные ЦИСЗ.
Скачать 01. Получение возможностей сервера.