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

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

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

Метод используется во время проектирования и разработки для получения информации о возможностях сервера ЦИСЗ в части поддержки спецификации FHIR.

Вызов метода доступен клиентскому приложению (МИС) без авторизации.

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

GET [FHIR_BASE]/metadata

Выходные данные метода:

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

Метод возвращает HTTP статус 200 ОК.

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

{ "resourceType": "CapabilityStatement", "url": "https://staging.cisz.by/api/fhirProxy/fhir/metadata", "name": "fhir.by API модуля обработки персональных данных Capability Statement", "status": "draft", "experimental": false, "date": "2025-05-13T11:22:12.1804676+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": "DocumentReference", "profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference", "supportedProfile": [ "https://fhir.by/StructureDefinition/AttachDocument" ], "interaction": [ { "code": "create" }, { "code": "read" }, { "code": "search-type" } ], "versioning": "no-version", "readHistory": false, "updateCreate": true, "conditionalCreate": false, "conditionalUpdate": false, "conditionalDelete": "single", "searchRevInclude": [ "DocumentReference:relatesto", "DocumentReference:related", "Condition:evidence-detail", "ImmunizationRecommendation:information", "QuestionnaireResponse:subject", "QuestionnaireResponse:patient", "List:item", "Observation:derived-from", "Observation:focus", "Appointment:supporting-info", "Contract:subject", "Contract:patient", "Composition:related", "Composition:entry", "Composition:subject" ], "searchParam": [ { "name": "event", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-event", "type": "token", "documentation": "Main clinical acts documented" }, { "name": "patient", "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient", "type": "reference", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUsage](deviceusage.html): Search by patient who used / uses the device\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationUsage](medicationusage.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for" }, { "name": "security-label", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label", "type": "token", "documentation": "Document security-tags" }, { "name": "relatesto", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-relatesto", "type": "reference", "documentation": "Target of the relationship" }, { "name": "date", "definition": "http://hl7.org/fhir/SearchParameter/clinical-date", "type": "date", "documentation": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): A date within the coverage time period.\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When consent was agreed to\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care
▲ Вверх