{
"description": "CapabilityStatement for the EEHRxF Resource Consumer actor. This actor queries for\\nclinical data resources following the International Patient Access (IPA) patterns and\\nIHE QEDm Clinical Data Consumer capabilities.\\n\\nThis CapabilityStatement defines the requirements for systems consuming direct resource\\naccess (beyond document-based exchange) in the EU EHR Exchange Format (EEHRxF) ecosystem.\\nIt inherits patterns from:\\n- **IPA (International Patient Access)**: Resource profiles and search parameter patterns\\n- **IHE QEDm (Query for Existing Data for Mobile)**: Clinical Data Consumer actor capabilities\\n\\n### Resource Flexibility (IPA Alignment)\\n\\nFollowing IPA's approach, clients are not required to consume all clinical resources listed\\nbelow. Clients MAY choose which resources to query based on their needs and the server's\\ndeclared capabilities. The only required capability is Patient lookup. This flexibility\\nallows clients to implement targeted use cases without requiring support for all resource types.\\n\\n**Required**: Patient (for lookup context)\\n**Optional (request based on needs and server support)**:\\n- Practitioner, Organization: Reference resolution\\n- Condition, AllergyIntolerance: Patient safety data\\n- Observation, DiagnosticReport: Clinical results\\n- MedicationRequest, MedicationDispense, MedicationStatement: Medication data\\n- Immunization: Vaccination records\\n- Encounter: Visit context\\n\\nClients should check the server's CapabilityStatement to discover which resources are available.\\n\\n### Security\\nSystems SHALL support SMART Backend Services authorization for all transactions.\\n\\n### Profile Inheritance\\nConsumers SHOULD expect resources conforming to EU Core profiles where available.",
"_filename": "CapabilityStatement-EEHRxF-ResourceConsumer.json",
"package_name": "hl7.fhir.eu.health-data-api",
"format": [ "json", "xml" ],
"date": "2026-02-02",
"publisher": "HL7 Europe",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "150",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "Europe"
} ]
} ],
"name": "EEHRxFResourceConsumer",
"copyright": "Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).",
"type": null,
"experimental": "false",
"resourceType": "CapabilityStatement",
"title": "EEHRxF Resource Consumer CapabilityStatement",
"package_version": "1.0.0-ballot",
"status": "active",
"id": "2fa76105-2c93-47e0-9f0c-48557b9db19a",
"kind": "requirements",
"url": "http://hl7.eu/fhir/health-data-api/CapabilityStatement/EEHRxF-ResourceConsumer",
"version": "1.0.0-ballot",
"contact": [ {
"name": "HL7 Europe",
"telecom": [ {
"value": "http://hl7.eu",
"system": "url"
} ]
} ],
"rest": [ {
"mode": "client",
"resource": [ {
"type": "Patient",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Read Patient by logical ID"
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Search for patients for lookup purposes"
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Patient logical ID"
}, {
"name": "identifier",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
"documentation": "Patient identifier (e.g., national ID, MRN) - required for patient lookup"
}, {
"name": "family",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/individual-family",
"documentation": "Patient family name"
}, {
"name": "given",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/individual-given",
"documentation": "Patient given name"
}, {
"name": "birthdate",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
"documentation": "Patient date of birth"
} ],
"documentation": "Patient resources are queried for patient lookup per PDQm [ITI-78] with identifier\nas a required search parameter. Note: Patient is used for lookup context, not as\na primary clinical data resource in this actor.",
"supportedProfile": [ "http://hl7.eu/fhir/base/StructureDefinition/patient-eu-core" ]
}, {
"type": "Practitioner",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Read Practitioner by logical ID"
} ],
"documentation": "Practitioner resources are read to resolve clinical context for referenced healthcare providers.\nClients SHOULD support this resource but MAY omit it based on their needs."
}, {
"type": "Organization",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Read Organization by logical ID"
} ],
"documentation": "Organization resources are read to resolve context for referenced healthcare organizations.\nClients SHOULD support this resource but MAY omit it based on their needs."
}, {
"type": "Condition",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Read Condition by logical ID"
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Search for Condition resources"
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient who has the condition (SHALL support)"
}, {
"name": "clinical-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
"documentation": "The clinical status of the condition"
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Condition-category",
"documentation": "The category of condition"
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "Code for the condition"
} ],
"documentation": "Condition resources represent problems, diagnoses, and health concerns.\nIf supported, clients SHALL support search by patient and SHOULD support additional filters.\nClients MAY omit this resource based on their needs."
}, {
"type": "AllergyIntolerance",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Read AllergyIntolerance by logical ID"
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Search for AllergyIntolerance resources"
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient who has the allergy or intolerance (SHALL support)"
}, {
"name": "clinical-status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status",
"documentation": "The clinical status of the allergy or intolerance"
} ],
"documentation": "AllergyIntolerance resources represent patient allergies and intolerances.\nIf supported, clients SHALL support search by patient.\nClients MAY omit this resource based on their needs."
}, {
"type": "Observation",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Read Observation by logical ID"
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Search for Observation resources"
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient the observation is about (SHALL support)"
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Observation-category",
"documentation": "Category of observation (e.g., vital-signs, laboratory)"
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "The code of the observation type"
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Obtained date/time. Date modifiers ge, le, gt, lt SHOULD be supported."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Observation-status",
"documentation": "The status of the observation"
} ],
"documentation": "Observation resources represent clinical observations including vital signs,\nlaboratory results, and other measurements. If supported, clients SHALL support\nsearch by patient and category. Clients MAY omit this resource based on their needs."
}, {
"type": "DiagnosticReport",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Read DiagnosticReport by logical ID"
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Search for DiagnosticReport resources"
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient the report is about (SHALL support)"
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-category",
"documentation": "Category of report (e.g., LAB, RAD)"
}, {
"name": "code",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
"documentation": "The code for the report type"
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "The clinically relevant time of the report"
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-status",
"documentation": "The status of the report"
} ],
"documentation": "DiagnosticReport resources represent laboratory results and imaging reports.\nIf supported, clients SHALL support search by patient and category.\nClients MAY omit this resource based on their needs."
}, {
"type": "MedicationRequest",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Read MedicationRequest by logical ID"
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Search for MedicationRequest resources"
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient for whom the medication was ordered (SHALL support)"
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/medications-status",
"documentation": "Status of the prescription"
}, {
"name": "intent",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-intent",
"documentation": "The intent of the medication request"
}, {
"name": "authoredon",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon",
"documentation": "Return prescriptions written on this date"
} ],
"documentation": "MedicationRequest resources represent medication orders and prescriptions.\nIf supported, clients SHALL support search by patient.\nClients MAY omit this resource based on their needs."
}, {
"type": "MedicationDispense",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Read MedicationDispense by logical ID"
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Search for MedicationDispense resources"
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient for whom the medication was dispensed (SHALL support)"
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/medications-status",
"documentation": "Status of the dispense"
}, {
"name": "whenhandedover",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/MedicationDispense-whenhandedover",
"documentation": "When the medication was handed over"
} ],
"documentation": "MedicationDispense resources represent medication dispensing events.\nIf supported, clients SHALL support search by patient.\nClients MAY omit this resource based on their needs."
}, {
"type": "Immunization",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Read Immunization by logical ID"
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Search for Immunization resources"
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient for the vaccination record (SHALL support)"
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "Vaccination date"
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Immunization-status",
"documentation": "Status of the immunization"
} ],
"documentation": "Immunization resources represent vaccination records.\nIf supported, clients SHALL support search by patient.\nClients MAY omit this resource based on their needs."
}, {
"type": "MedicationStatement",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Read MedicationStatement by logical ID"
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Search for MedicationStatement resources"
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient for the medication statement (SHALL support)"
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/medications-status",
"documentation": "Status of the medication statement"
}, {
"name": "effective",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/MedicationStatement-effective",
"documentation": "Date when patient was taking the medication"
} ],
"documentation": "MedicationStatement resources represent a patient's medication usage, including\nself-reported medications. If supported, clients SHALL support search by patient.\nClients MAY omit this resource based on their needs."
}, {
"type": "Encounter",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"interaction": [ {
"code": "read",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Read Encounter by logical ID"
}, {
"code": "search-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Search for Encounter resources"
} ],
"searchParam": [ {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "The patient present at the encounter (SHALL support)"
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
"documentation": "A date within the encounter period"
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-status",
"documentation": "Status of the encounter"
}, {
"name": "class",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Encounter-class",
"documentation": "Classification of the encounter (e.g., inpatient, outpatient)"
} ],
"documentation": "Encounter resources represent patient encounters (visits, admissions, etc.).\nIf supported, clients SHALL support search by patient.\nClients MAY omit this resource based on their needs."
} ],
"security": {
"cors": false,
"service": [ {
"coding": [ {
"code": "SMART-on-FHIR",
"system": "http://hl7.org/fhir/restful-security-service"
} ]
} ],
"description": "SMART Backend Services authorization is REQUIRED for all transactions.\nSystems SHALL:\n- Authenticate using JWT client credentials (RFC 7523)\n- Request appropriate scopes for resource access\n- Use TLS 1.2 or higher for all communications\n\n### Resource Flexibility\n\nFollowing IPA's approach, clients MAY choose which clinical resources to request based on their\nneeds and the server's capabilities (as declared in the server's CapabilityStatement). Patient\nlookup is required; other resources are requested as needed.\n\n### Scopes for Desired Resources\n\nClients SHALL request scopes for the resources they need:\n- system/Patient.read, system/Patient.search (REQUIRED - read and search Patient)\n- system/Condition.read, system/Condition.search (if Condition needed)\n- system/AllergyIntolerance.read, system/AllergyIntolerance.search (if AllergyIntolerance needed)\n- system/Observation.read, system/Observation.search (if Observation needed)\n- system/DiagnosticReport.read, system/DiagnosticReport.search (if DiagnosticReport needed)\n- system/MedicationRequest.read, system/MedicationRequest.search (if MedicationRequest needed)\n- system/MedicationDispense.read, system/MedicationDispense.search (if MedicationDispense needed)\n- system/Immunization.read, system/Immunization.search (if Immunization needed)\n- system/MedicationStatement.read, system/MedicationStatement.search (if MedicationStatement needed)\n- system/Encounter.read, system/Encounter.search (if Encounter needed)\n- system/Practitioner.read (if Practitioner needed)\n- system/Organization.read (if Organization needed)"
},
"documentation": "The Resource Consumer actor queries for clinical data resources from a Resource Access\nProvider following IPA and QEDm patterns. This enables direct resource access complementing\ndocument-based exchange via MHD.\n\nAll transactions require SMART Backend Services authorization."
} ]
}