API de datos de salud del EHDS
Cómo esperan las guías de HL7 Europe que se intercambien los datos de salud: los actores que publican, sirven y consumen documentos y recursos, qué debe soportar cada uno y los tipos de documento LOINC asociados a las categorías prioritarias. Todo se lee de los CapabilityStatement, parámetros de búsqueda y operaciones de los paquetes publicados.
Actores 12
Cada actor es un CapabilityStatement. Un servidor responde a peticiones; un cliente las envía. La expectativa es el nivel de conformidad que da el statement: SHALL, SHOULD o MAY.
EU Health Data API 7
EEHRxF Document Access Providerservidor
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.
- Seguridad
- 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
| Recurso FHIR | Expectativa | Interacciones | Parámetros de búsqueda | Perfiles |
|---|---|---|---|---|
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 Optionservidor
CapabilityStatement for the Document Submission Option on the EEHRxF Document Access Provider.
- Seguridad
- Additional scope required for document submission: - system/DocumentReference.create (create DocumentReference via ITI-105)
| Recurso FHIR | Expectativa | Interacciones | Parámetros de búsqueda | Perfiles |
|---|---|---|---|---|
DocumentReference | SHALL | create SHALL | EehrxfMhdDocumentReferenceIHE.MHD.SimplifiedPublish.DocumentReferenceIHE.MHD.Minimal.DocumentReference |
EEHRxF Document Consumercliente
CapabilityStatement for the EEHRxF Document Consumer actor. This composite actor consumes EEHRxF FHIR Documents by querying a Document Access Provider.
- Seguridad
- 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
| Recurso FHIR | Expectativa | Interacciones | Parámetros de búsqueda | Perfiles |
|---|---|---|---|---|
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 Publishercliente
CapabilityStatement for the EEHRxF Document Publisher actor. This composite actor produces EEHRxF FHIR Documents and publishes them to a Document Access Provider.
- Seguridad
- 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
| Recurso FHIR | Expectativa | Interacciones | Parámetros de búsqueda | Perfiles |
|---|---|---|---|---|
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 Providerservidor
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.
- Seguridad
- 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
| Recurso FHIR | Expectativa | Interacciones | Parámetros de búsqueda | Perfiles |
|---|---|---|---|---|
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 Providerservidor
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.
- Seguridad
- 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
- Instancia
http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-server
| Recurso FHIR | Expectativa | Interacciones | Parámetros de búsqueda | Perfiles |
|---|---|---|---|---|
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 Consumercliente
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.
- Seguridad
- 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
| Recurso FHIR | Expectativa | Interacciones | Parámetros de búsqueda | Perfiles |
|---|---|---|---|---|
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 Providerservidor
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.
- Seguridad
- 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
| Recurso FHIR | Expectativa | Interacciones | Parámetros de búsqueda | Perfiles |
|---|---|---|---|---|
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 Consumercliente
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.
- Seguridad
- 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
| Recurso FHIR | Expectativa | Interacciones | Parámetros de búsqueda | Perfiles |
|---|---|---|---|---|
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 Providerservidor
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.
- Seguridad
- 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
- Instancia
http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-server
| Recurso FHIR | Expectativa | Interacciones | Parámetros de búsqueda | Perfiles |
|---|---|---|---|---|
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 Consumercliente
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.
- Seguridad
- 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
| Recurso FHIR | Expectativa | Interacciones | Parámetros de búsqueda | Perfiles |
|---|---|---|---|---|
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)servidor
IHE RAD Manifest based Access to DICOM Objects(MADO) - Document Responder (server). It extends MHD Document Responder (client).
| Recurso FHIR | Expectativa | Interacciones | Parámetros de búsqueda | Perfiles |
|---|---|---|---|---|
DocumentReference | bodysite token, SHALLmodality token, SHALLstudy-instance-uid token, SHALLaccession-number token, SHALL |
Tipos de documento por categoría prioritaria 6
La API de datos de salud asocia el código de cada categoría prioritaria con los tipos de documento LOINC que lleva un DocumentReference de esa categoría.
| Categoría | Código de categoría | Tipo de documento | Relación |
|---|---|---|---|
| Resumen del paciente | Patient-Summaries | LOINC 60591-5 Patient summary Document | specializes |
| Informe de alta | Discharge-Reports | LOINC 18842-5 Discharge summary | specializes |
| Informe de alta | Discharge-Reports | LOINC 100719-4 Surgical oncology Discharge summary | specializes |
| Resultados de pruebas médicas | Laboratory-Reports | LOINC 11502-2 Laboratory report | specializes |
| Estudios de imagen médica e informes | Medical-Imaging | LOINC 85430-7 Diagnostic imaging report | specializes |
| Estudios de imagen médica e informes | Medical-Imaging | LOINC 18748-4 Diagnostic imaging study | specializes |
Parámetros de búsqueda definidos por las guías 2
| Nombre | Tipo | Se aplica a | Expresión | Descripción |
|---|---|---|---|---|
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. |
Operaciones 1
| Nombre | Niveles | Se aplica a | Parámetros | Descripción |
|---|---|---|---|---|
$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. |