API danych zdrowotnych EHDS
Jak przewodniki HL7 Europe zakładają wymianę danych zdrowotnych: uczestnicy, którzy publikują, udostępniają i odbierają dokumenty oraz zasoby, co każdy z nich musi obsługiwać, oraz typy dokumentów LOINC powiązane z kategoriami priorytetowymi. Wszystko pochodzi z CapabilityStatement, parametrów wyszukiwania i operacji w opublikowanych pakietach.
Uczestnicy 12
Każdy uczestnik to CapabilityStatement. Serwer odpowiada na żądania, klient je wysyła. Oczekiwanie to poziom zgodności podany w statement: SHALL, SHOULD lub MAY.
EU Health Data API 7
EEHRxF Document Access Providerserwer
CapabilityStatement for the EEHRxF Document Access Provider actor. This composite actor provides access to EEHRxF FHIR Documents by serving them to Document Consumers via query APIs.
- Bezpieczeństwo
- SMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL: - Validate JWT client credentials (RFC 7523) - Verify appropriate scopes for document operations - Use TLS 1.2 or higher for all communications
| Zasób FHIR | Oczekiwanie | Interakcje | Parametry wyszukiwania | Profile |
|---|---|---|---|---|
DocumentReference | SHALL | read SHALLsearch-type SHALL | patient reference, SHALLtype token, SHALL_id token, SHALLcategory token, SHOULDdate date, SHOULDstatus token, SHOULDidentifier token, SHOULDperiod date, MAYformat token, MAY_lastupdated date, MAYsetting token, MAYfacility token, MAYevent token, MAYsecurity-label token, MAYrelated reference, MAYauthor.given string, MAYauthor.family string, MAYpatient.identifier token, MAY | EehrxfMhdDocumentReferenceIHE.MHD.Minimal.DocumentReference |
Binary | SHALL | read SHALL | ||
Patient | SHALL | read SHALLsearch-type SHALL | identifier token, SHALL_id token, SHALLfamily string, SHOULDgiven string, SHOULDbirthdate date, SHOULD | patient-eu-core |
EEHRxF Document Access Provider - Document Submission Optionserwer
CapabilityStatement for the Document Submission Option on the EEHRxF Document Access Provider.
- Bezpieczeństwo
- Additional scope required for document submission: - system/DocumentReference.create (create DocumentReference via ITI-105)
| Zasób FHIR | Oczekiwanie | Interakcje | Parametry wyszukiwania | Profile |
|---|---|---|---|---|
DocumentReference | SHALL | create SHALL | EehrxfMhdDocumentReferenceIHE.MHD.SimplifiedPublish.DocumentReferenceIHE.MHD.Minimal.DocumentReference |
EEHRxF Document Consumerklient
CapabilityStatement for the EEHRxF Document Consumer actor. This composite actor consumes EEHRxF FHIR Documents by querying a Document Access Provider.
- Bezpieczeństwo
- SMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL: - Authenticate using JWT client credentials (RFC 7523) - Request appropriate scopes for document access - Use TLS 1.2 or higher for all communications
| Zasób FHIR | Oczekiwanie | Interakcje | Parametry wyszukiwania | Profile |
|---|---|---|---|---|
DocumentReference | SHALL | read SHALLsearch-type SHALL | patient reference, SHALLtype token, SHALL_id token, SHALLcategory token, SHOULDdate date, SHOULDstatus token, SHOULDidentifier token, SHOULD | EehrxfMhdDocumentReferenceIHE.MHD.Minimal.DocumentReference |
Binary | SHALL | read SHALL | ||
Patient | SHALL | read SHALLsearch-type SHALL | identifier token, SHALL_id token, SHALLfamily string, SHOULDgiven string, SHOULDbirthdate date, SHOULD | patient-eu-core |
EEHRxF Document Publisherklient
CapabilityStatement for the EEHRxF Document Publisher actor. This composite actor produces EEHRxF FHIR Documents and publishes them to a Document Access Provider.
- Bezpieczeństwo
- SMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL: - Authenticate using JWT client credentials (RFC 7523) - Request appropriate scopes for document submission and patient lookup - Use TLS 1.2 or higher for all communications
| Zasób FHIR | Oczekiwanie | Interakcje | Parametry wyszukiwania | Profile |
|---|---|---|---|---|
DocumentReference | SHALL | create SHALL | EehrxfMhdDocumentReferenceIHE.MHD.SimplifiedPublish.DocumentReferenceIHE.MHD.Minimal.DocumentReference | |
Patient | SHALL | read SHALLsearch-type SHALL | identifier token, SHALL_id token, SHALLfamily string, SHOULDgiven string, SHOULDbirthdate date, SHOULD | patient-eu-core |
EEHRxF Grouped Document Publisher/Access Providerserwer
CapabilityStatement for the grouped EEHRxF Document Publisher and Document Access Provider actors. This represents a deployment where document production and access provision are co-located in the same system.
- Bezpieczeństwo
- SMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL: - Validate JWT client credentials (RFC 7523) - Verify appropriate scopes for document access - Use TLS 1.2 or higher for all communications
| Zasób FHIR | Oczekiwanie | Interakcje | Parametry wyszukiwania | Profile |
|---|---|---|---|---|
DocumentReference | SHALL | read SHALLsearch-type SHALL | patient reference, SHALLtype token, SHALL_id token, SHALLcategory token, SHOULDdate date, SHOULDstatus token, SHOULDidentifier token, SHOULDperiod date, MAYformat token, MAY | EehrxfMhdDocumentReferenceIHE.MHD.Minimal.DocumentReference |
Binary | SHALL | read SHALL | ||
Patient | SHALL | read SHALLsearch-type SHALL | identifier token, SHALL_id token, SHALLfamily string, SHOULDgiven string, SHOULDbirthdate date, SHOULD | patient-eu-core |
EEHRxF Resource Access Providerserwer
CapabilityStatement for the EEHRxF Resource Access Provider actor. This actor serves clinical data resources following the International Patient Access (IPA) patterns and IHE QEDm Clinical Data Source capabilities.
- Bezpieczeństwo
- SMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL: - Validate JWT client credentials (RFC 7523) - Verify appropriate scopes for resource access - Use TLS 1.2 or higher for all communications - Return HTTP 401, 403, or 404 for unauthorized requests
- Implementuje
http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-server
| Zasób FHIR | Oczekiwanie | Interakcje | Parametry wyszukiwania | Profile |
|---|---|---|---|---|
Patient | SHALL | read SHALLsearch-type SHALL | _id token, SHALLidentifier token, SHALLfamily string, SHOULDgiven string, SHOULDbirthdate date, SHOULD | patient-eu-core |
Practitioner | SHOULD | read SHALL | ||
Organization | SHOULD | read SHALL | ||
Condition | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLclinical-status token, SHOULDcategory token, SHOULDcode token, SHOULD | |
AllergyIntolerance | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLclinical-status token, SHOULD | |
Observation | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLcategory token, SHALLcode token, SHOULDdate date, SHOULDstatus token, SHOULD | |
DiagnosticReport | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLcategory token, SHALLcode token, SHOULDdate date, SHOULDstatus token, SHOULD | |
MedicationRequest | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLstatus token, SHOULDintent token, SHOULDauthoredon date, SHOULD | |
MedicationDispense | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLstatus token, SHOULDwhenhandedover date, SHOULD | |
Immunization | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLdate date, SHOULDstatus token, SHOULD | |
MedicationStatement | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLstatus token, SHOULDeffective date, SHOULD | |
Encounter | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLdate date, SHOULDstatus token, SHOULDclass token, SHOULD |
EEHRxF Resource Consumerklient
CapabilityStatement for the EEHRxF Resource Consumer actor. This actor queries for clinical data resources following the International Patient Access (IPA) patterns and IHE QEDm Clinical Data Consumer capabilities.
- Bezpieczeństwo
- SMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL: - Authenticate using JWT client credentials (RFC 7523) - Request appropriate scopes for resource access - Use TLS 1.2 or higher for all communications
| Zasób FHIR | Oczekiwanie | Interakcje | Parametry wyszukiwania | Profile |
|---|---|---|---|---|
Patient | SHALL | read SHALLsearch-type SHALL | _id token, SHALLidentifier token, SHALLfamily string, SHOULDgiven string, SHOULDbirthdate date, SHOULD | patient-eu-core |
Practitioner | SHOULD | read SHALL | ||
Organization | SHOULD | read SHALL | ||
Condition | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLclinical-status token, SHOULDcategory token, SHOULDcode token, SHOULD | |
AllergyIntolerance | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLclinical-status token, SHOULD | |
Observation | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLcategory token, SHALLcode token, SHOULDdate date, SHOULDstatus token, SHOULD | |
DiagnosticReport | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLcategory token, SHALLcode token, SHOULDdate date, SHOULDstatus token, SHOULD | |
MedicationRequest | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLstatus token, SHOULDintent token, SHOULDauthoredon date, SHOULD | |
MedicationDispense | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLstatus token, SHOULDwhenhandedover date, SHOULD | |
Immunization | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLdate date, SHOULDstatus token, SHOULD | |
MedicationStatement | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLstatus token, SHOULDeffective date, SHOULD | |
Encounter | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLdate date, SHOULDstatus token, SHOULDclass token, SHOULD |
HL7 Europe Imaging Report R4 4
EEHRxF Imaging Report Document Access Providerserwer
CapabilityStatement for the EEHRxF Imaging Report Document Access Provider actor. This composite actor provides access to EEHRxF FHIR Documents by serving them to Document Consumers via query APIs.
- Bezpieczeństwo
- SMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL: - Validate JWT client credentials (RFC 7523) - Verify appropriate scopes for document operations - Use TLS 1.2 or higher for all communications
| Zasób FHIR | Oczekiwanie | Interakcje | Parametry wyszukiwania | Profile |
|---|---|---|---|---|
DocumentReference | SHALL | read SHALLsearch-type SHALL | patient reference, SHALLtype token, SHOULD_id token, SHALLcategory token, SHALLdate date, SHOULDstatus token, SHOULDidentifier token, SHOULDperiod date, MAYformat token, MAY_lastupdated date, MAYsetting token, MAYfacility token, MAYevent token, MAYsecurity-label token, MAYrelated reference, MAYauthor.given string, MAYauthor.family string, MAYpatient.identifier token, MAYbodysite token, SHOULDmodality token, SHOULD | |
Binary | SHALL | read SHALL | ||
Patient | SHALL | read SHALLsearch-type SHALL | identifier token, SHALL_id token, SHALLfamily string, SHOULDgiven string, SHOULDbirthdate date, SHOULD |
EEHRxF ImagingReport Document Consumerklient
CapabilityStatement for the EEHRxF Imaging Report Document Consumer actor. This composite actor consumes EEHRxF FHIR Imaging Report Documents by querying a Imaging Report Document Access Provider.
- Bezpieczeństwo
- SMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL: - Authenticate using JWT client credentials (RFC 7523) - Request appropriate scopes for document access - Use TLS 1.2 or higher for all communications
| Zasób FHIR | Oczekiwanie | Interakcje | Parametry wyszukiwania | Profile |
|---|---|---|---|---|
DocumentReference | SHALL | read SHALLsearch-type SHALL | patient reference, SHALLtype token, SHALL_id token, SHALLcategory token, SHOULDdate date, SHOULDstatus token, SHOULDidentifier token, SHOULDbodysite token, SHOULDmodality token, SHOULD | |
Binary | SHALL | read SHALL | ||
Patient | SHALL | read SHALLsearch-type SHALL | identifier token, SHALL_id token, SHALLfamily string, SHOULDgiven string, SHOULDbirthdate date, SHOULD |
EEHRxF Imaging Report Resource Access Providerserwer
CapabilityStatement for the EEHRxF Imaging Report Resource Access Provider actor. This actor serves clinical data resources following the International Patient Access (IPA) patterns and IHE QEDm Clinical Data Source capabilities.
- Bezpieczeństwo
- SMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL: - Validate JWT client credentials (RFC 7523) - Verify appropriate scopes for resource access - Use TLS 1.2 or higher for all communications - Return HTTP 401, 403, or 404 for unauthorized requests
- Implementuje
http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-server
| Zasób FHIR | Oczekiwanie | Interakcje | Parametry wyszukiwania | Profile |
|---|---|---|---|---|
Patient | SHALL | read SHALLsearch-type SHALL | _id token, SHALLidentifier token, SHALLfamily string, SHOULDgiven string, SHOULDbirthdate date, SHOULD | |
Practitioner | SHOULD | read SHALL | ||
Organization | SHOULD | read SHALL | ||
Condition | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLclinical-status token, SHOULDcategory token, SHOULDcode token, SHOULD | |
AllergyIntolerance | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLclinical-status token, SHOULD | |
Observation | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLcategory token, SHALLcode token, SHOULDdate date, SHOULDstatus token, SHOULD | |
DiagnosticReport | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLcategory token, SHALLcode token, SHOULDdate date, SHOULDstatus token, SHOULD | |
MedicationRequest | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLstatus token, SHOULDintent token, SHOULDauthoredon date, SHOULD | |
MedicationDispense | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLstatus token, SHOULDwhenhandedover date, SHOULD | |
Encounter | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLdate date, SHOULDstatus token, SHOULDclass token, SHOULD | |
ImagingStudy | SHALL | read SHALLsearch-type SHALL | based-on reference, SHALLbody-site token, SHALLdicom-class token, SHOULDmodality token, SHALLidentifier token, SHALLinstance token, SHOULDpatient reference, SHALLperformer reference, SHOULDreason token, SHOULDreferrer reference, SHOULDseries token, SHOULDstarted date, SHALLsubject reference, SHALLstatus token, SHALL | |
Device | SHOULD | read SHALL | ||
Composition | SHALL | read SHALL | ||
Procedure | SHALL | read SHALL | patient reference, SHALLsubject reference, SHALL | |
ServiceRequest | SHALL | read SHALL | identifier token, SHALLpatient reference, SHALLsubject reference, SHALL | |
AdverseEvent | SHALL | read SHALL | ||
Provenance | SHALL | read SHALL | patient reference, SHALLsubject reference, SHALLtarget reference, SHALL | |
Basic | SHALL | read SHALL |
EEHRxF Imaging Report Resource Consumerklient
CapabilityStatement for the EEHRxF Imaging Report Resource Consumer actor. This actor queries for clinical data resources following the International Patient Access (IPA) patterns and IHE QEDm Clinical Data Consumer capabilities.
- Bezpieczeństwo
- SMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL: - Authenticate using JWT client credentials (RFC 7523) - Request appropriate scopes for resource access - Use TLS 1.2 or higher for all communications
| Zasób FHIR | Oczekiwanie | Interakcje | Parametry wyszukiwania | Profile |
|---|---|---|---|---|
Patient | SHALL | read SHALLsearch-type SHALL | _id token, SHALLidentifier token, SHALLfamily string, SHOULDgiven string, SHOULDbirthdate date, SHOULD | |
Practitioner | SHOULD | read SHALL | ||
Organization | SHOULD | read SHALL | ||
Condition | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLclinical-status token, SHOULDcategory token, SHOULDcode token, SHOULD | |
AllergyIntolerance | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLclinical-status token, SHOULD | |
Observation | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLcategory token, SHALLcode token, SHOULDdate date, SHOULDstatus token, SHOULD | |
DiagnosticReport | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLcategory token, SHALLcode token, SHOULDdate date, SHOULDstatus token, SHOULD | |
MedicationRequest | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLstatus token, SHOULDintent token, SHOULDauthoredon date, SHOULD | |
MedicationDispense | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLstatus token, SHOULDwhenhandedover date, SHOULD | |
Encounter | SHOULD | read SHALLsearch-type SHALL | patient reference, SHALLdate date, SHOULDstatus token, SHOULDclass token, SHOULD | |
ImagingStudy | SHOULD | read SHOULDsearch-type SHOULD | based-on reference, SHOULDbody-site token, SHOULDdicom-class token, MAYmodality token, SHOULDidentifier token, SHOULDinstance token, MAYpatient reference, SHOULDperformer reference, MAYreason token, MAYreferrer reference, MAYseries token, MAYstarted date, SHOULDsubject reference, SHOULDstatus token, SHOULD | |
Device | SHOULD | read SHOULD | ||
Composition | SHOULD | read SHOULD | ||
Procedure | SHOULD | read SHOULD | patient reference, SHOULDsubject reference, SHOULD | |
ServiceRequest | SHOULD | read SHOULD | identifier token, SHOULDpatient reference, SHOULDsubject reference, SHOULD | |
AdverseEvent | SHOULD | read SHOULD | ||
Provenance | SHOULD | read SHOULD | patient reference, SHOULDsubject reference, SHOULDtarget reference, SHOULD | |
Basic | SHOULD | read SHOULD |
EU Imaging Manifest and Access (IHE-MADO additions) 1
MADO Document Responder (server)serwer
IHE RAD Manifest based Access to DICOM Objects(MADO) - Document Responder (server). It extends MHD Document Responder (client).
| Zasób FHIR | Oczekiwanie | Interakcje | Parametry wyszukiwania | Profile |
|---|---|---|---|---|
DocumentReference | bodysite token, SHALLmodality token, SHALLstudy-instance-uid token, SHALLaccession-number token, SHALL |
Typy dokumentów według kategorii priorytetowej 6
API danych zdrowotnych wiąże kod każdej kategorii priorytetowej z typami dokumentów LOINC, które zawiera DocumentReference tej kategorii.
| Kategoria | Kod kategorii | Typ dokumentu | Relacja |
|---|---|---|---|
| Zestawienie danych pacjenta (patient summary) | Patient-Summaries | LOINC 60591-5 Patient summary Document | specializes |
| Wypis ze szpitala | Discharge-Reports | LOINC 18842-5 Discharge summary | specializes |
| Wypis ze szpitala | Discharge-Reports | LOINC 100719-4 Surgical oncology Discharge summary | specializes |
| Wyniki badań medycznych | Laboratory-Reports | LOINC 11502-2 Laboratory report | specializes |
| Badania obrazowe i ich opisy | Medical-Imaging | LOINC 85430-7 Diagnostic imaging report | specializes |
| Badania obrazowe i ich opisy | Medical-Imaging | LOINC 18748-4 Diagnostic imaging study | specializes |
Parametry wyszukiwania zdefiniowane w przewodnikach 2
| Nazwa | Typ | Dotyczy | Wyrażenie | Opis |
|---|---|---|---|---|
bodysite | token | DocumentReference | DocumentReference.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.bodySite').extension('concept').value | Searches for document references with a specific body site. |
modality | token | DocumentReference | DocumentReference.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.modality').value | Searches for document references with a specific modality. |
Operacje 1
| Nazwa | Poziomy | Dotyczy | Parametry | Opis |
|---|---|---|---|---|
$document | instance | return out 1..1 Bundle | This operation generates a FHIR report from an DiagnosticReport resource that points to a Composition resource. Its behavior is identical to the Composition/$document operation but adds the DiagnosticReport and its referenced resources to the Bundle. |