FHIRsmith: CapabilityStatement/CapabilityStatement-EEHRxF-ResourceConsumer.json

FHIR IG analytics

Package	hl7.fhir.eu.eu-health-data-api
Resource Type	CapabilityStatement
Id	CapabilityStatement-EEHRxF-ResourceConsumer.json
FHIR Version	R4
Source	https://build.fhir.org/ig/euridice-org/eu-health-data-api/CapabilityStatement-EEHRxF-ResourceConsumer.html
URL	http://hl7.eu/fhir/eu-health-data-api/CapabilityStatement/EEHRxF-ResourceConsumer
Version	0.1.0
Status	active
Date	2026-02-02
Name	EEHRxFResourceConsumer
Title	EEHRxF Resource Consumer CapabilityStatement
Realm	eu
Authority	hl7
Description	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. This CapabilityStatement defines the requirements for systems consuming direct resource access (beyond document-based exchange) in the EU EHR Exchange Format (EEHRxF) ecosystem. It inherits patterns from: - IPA (International Patient Access): Resource profiles and search parameter patterns - IHE QEDm (Query for Existing Data for Mobile): Clinical Data Consumer actor capabilities ### Resource Flexibility (IPA Alignment) Following IPA's approach, clients are not required to consume all clinical resources listed below. Clients MAY choose which resources to query based on their needs and the server's declared capabilities. The only required capability is Patient lookup. This flexibility allows clients to implement targeted use cases without requiring support for all resource types. Required: Patient (for lookup context) Optional (request based on needs and server support): - Practitioner, Organization: Reference resolution - Condition, AllergyIntolerance: Patient safety data - Observation, DiagnosticReport: Clinical results - MedicationRequest, MedicationDispense: Medication data - Encounter: Visit context Clients should check the server's CapabilityStatement to discover which resources are available. ### Security Systems SHALL support SMART Backend Services authorization for all transactions. ### Profile Inheritance Consumers SHOULD expect resources conforming to EU Core profiles where available.
Copyright	Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement EEHRxF-ResourceConsumer

EEHRxF Resource Consumer CapabilityStatement

Implementation Guide Version: 0.1.0
FHIR Version: 4.0.1
Supported Formats: json, xml
Published on: 2026-02-02
Published by: HL7 Europe

Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: `client`

The Resource Consumer actor queries for clinical data resources from a Resource Access Provider following IPA and QEDm patterns. This enables direct resource access complementing document-based exchange via MHD.

All transactions require SMART Backend Services authorization.

Security

Enable CORS: no

Security services supported: SMART-on-FHIR

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

Resource Flexibility

Following IPA's approach, clients MAY choose which clinical resources to request based on their needs and the server's capabilities (as declared in the server's CapabilityStatement). Patient lookup is required; other resources are requested as needed.

Scopes for Desired Resources

Clients SHALL request scopes for the resources they need:

system/Patient.read, system/Patient.search (REQUIRED - read and search Patient)

system/Condition.read, system/Condition.search (if Condition needed)

system/AllergyIntolerance.read, system/AllergyIntolerance.search (if AllergyIntolerance needed)

system/Observation.read, system/Observation.search (if Observation needed)

system/DiagnosticReport.read, system/DiagnosticReport.search (if DiagnosticReport needed)

system/MedicationRequest.read, system/MedicationRequest.search (if MedicationRequest needed)

system/MedicationDispense.read, system/MedicationDispense.search (if MedicationDispense needed)

system/Encounter.read, system/Encounter.search (if Encounter needed)

system/Practitioner.read (if Practitioner needed)

system/Organization.read (if Organization needed)

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	R	S	Searches
Patient	Y	Y	_id, identifier, family, given, birthdate
Practitioner	Y
Organization	Y
Condition	Y	Y	patient, clinical-status, category, code
AllergyIntolerance	Y	Y	patient, clinical-status
Observation	Y	Y	patient, category, code, date, status
DiagnosticReport	Y	Y	patient, category, code, date, status
MedicationRequest	Y	Y	patient, status, intent, authoredon
MedicationDispense	Y	Y	patient, status, whenhandedover
Encounter	Y	Y	patient, date, status, class

Resource Conformance: SHALL Patient

Core FHIR Resource
Patient

Reference Policy

Interaction summary

SHALL support
read
Read Patient by logical ID

search-type
Search for patients for lookup purposes

Documentation

Patient resources are queried for patient lookup per PDQm [ITI-78] with identifier as a required search parameter. Note: Patient is used for lookup context, not as a primary clinical data resource in this actor.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	Patient logical ID
SHALL	identifier	`token`	Patient identifier (e.g., national ID, MRN) - required for patient lookup
SHOULD	family	`string`	Patient family name
SHOULD	given	`string`	Patient given name
SHOULD	birthdate	`date`	Patient date of birth

Resource Conformance: SHOULD Practitioner

Core FHIR Resource
Practitioner

Reference Policy

Interaction summary

SHALL support
read
Read Practitioner by logical ID

Documentation

Practitioner resources are read to resolve clinical context for referenced healthcare providers. Clients SHOULD support this resource but MAY omit it based on their needs.

Resource Conformance: SHOULD Organization

Core FHIR Resource
Organization

Reference Policy

Interaction summary

SHALL support
read
Read Organization by logical ID

Documentation

Organization resources are read to resolve context for referenced healthcare organizations. Clients SHOULD support this resource but MAY omit it based on their needs.

Resource Conformance: SHOULD Condition

Core FHIR Resource
Condition

Reference Policy

Interaction summary

SHALL support
read
Read Condition by logical ID

search-type
Search for Condition resources

Documentation

Condition resources represent problems, diagnoses, and health concerns. If supported, clients SHALL support search by patient and SHOULD support additional filters. Clients MAY omit this resource based on their needs.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	The patient who has the condition (SHALL support)
SHOULD	clinical-status	`token`	The clinical status of the condition
SHOULD	category	`token`	The category of condition
SHOULD	code	`token`	Code for the condition

Resource Conformance: SHOULD AllergyIntolerance

Core FHIR Resource
AllergyIntolerance

Reference Policy

Interaction summary

SHALL support
read
Read AllergyIntolerance by logical ID

search-type
Search for AllergyIntolerance resources

Documentation

AllergyIntolerance resources represent patient allergies and intolerances. If supported, clients SHALL support search by patient. Clients MAY omit this resource based on their needs.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	The patient who has the allergy or intolerance (SHALL support)
SHOULD	clinical-status	`token`	The clinical status of the allergy or intolerance

Resource Conformance: SHOULD Observation

Core FHIR Resource
Observation

Reference Policy

Interaction summary

SHALL support
read
Read Observation by logical ID

search-type
Search for Observation resources

Documentation

Observation resources represent clinical observations including vital signs, laboratory results, and other measurements. If supported, clients SHALL support search by patient and category. Clients MAY omit this resource based on their needs.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	The patient the observation is about (SHALL support)
SHALL	category	`token`	Category of observation (e.g., vital-signs, laboratory)
SHOULD	code	`token`	The code of the observation type
SHOULD	date	`date`	Obtained date/time. Date modifiers ge, le, gt, lt SHOULD be supported.
SHOULD	status	`token`	The status of the observation

Resource Conformance: SHOULD DiagnosticReport

Core FHIR Resource
DiagnosticReport

Reference Policy

Interaction summary

SHALL support
read
Read DiagnosticReport by logical ID

search-type
Search for DiagnosticReport resources

Documentation

DiagnosticReport resources represent laboratory results and imaging reports. If supported, clients SHALL support search by patient and category. Clients MAY omit this resource based on their needs.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	The patient the report is about (SHALL support)
SHALL	category	`token`	Category of report (e.g., LAB, RAD)
SHOULD	code	`token`	The code for the report type
SHOULD	date	`date`	The clinically relevant time of the report
SHOULD	status	`token`	The status of the report

Resource Conformance: SHOULD MedicationRequest

Core FHIR Resource
MedicationRequest

Reference Policy

Interaction summary

SHALL support
read
Read MedicationRequest by logical ID

search-type
Search for MedicationRequest resources

Documentation

MedicationRequest resources represent medication orders and prescriptions. If supported, clients SHALL support search by patient. Clients MAY omit this resource based on their needs.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	The patient for whom the medication was ordered (SHALL support)
SHOULD	status	`token`	Status of the prescription
SHOULD	intent	`token`	The intent of the medication request
SHOULD	authoredon	`date`	Return prescriptions written on this date

Resource Conformance: SHOULD MedicationDispense

Core FHIR Resource
MedicationDispense

Reference Policy

Interaction summary

SHALL support
read
Read MedicationDispense by logical ID

search-type
Search for MedicationDispense resources

Documentation

MedicationDispense resources represent medication dispensing events. If supported, clients SHALL support search by patient. Clients MAY omit this resource based on their needs.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	The patient for whom the medication was dispensed (SHALL support)
SHOULD	status	`token`	Status of the dispense
SHOULD	whenhandedover	`date`	When the medication was handed over

Resource Conformance: SHOULD Encounter

Core FHIR Resource
Encounter

Reference Policy

Interaction summary

SHALL support
read
Read Encounter by logical ID

search-type
Search for Encounter resources

Documentation

Encounter resources represent patient encounters (visits, admissions, etc.). If supported, clients SHALL support search by patient. Clients MAY omit this resource based on their needs.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	The patient present at the encounter (SHALL support)
SHOULD	date	`date`	A date within the encounter period
SHOULD	status	`token`	Status of the encounter
SHOULD	class	`token`	Classification of the encounter (e.g., inpatient, outpatient)

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "EEHRxF-ResourceConsumer",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.eu/fhir/eu-health-data-api/CapabilityStatement/EEHRxF-ResourceConsumer",
  "version": "0.1.0",
  "name": "EEHRxFResourceConsumer",
  "title": "EEHRxF Resource Consumer CapabilityStatement",
  "status": "active",
  "experimental": false,
  "date": "2026-02-02",
  "publisher": "HL7 Europe",
  "contact": [
    {
      "name": "HL7 Europe",
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.eu"
        }
      ]
    }
  ],
  "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: Medication data\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.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "150",
          "display": "Europe"
        }
      ]
    }
  ],
  "copyright": "Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).",
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "rest": [
    {
      "mode": "client",
      "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.",
      "security": {
        "cors": false,
        "service": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/restful-security-service",
                "code": "SMART-on-FHIR"
              }
            ]
          }
        ],
        "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/Encounter.read, system/Encounter.search (if Encounter needed)\n- system/Practitioner.read (if Practitioner needed)\n- system/Organization.read (if Organization needed)"
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Patient",
          "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.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read Patient by logical ID"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search for patients for lookup purposes"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Patient logical ID"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
              "type": "token",
              "documentation": "Patient identifier (e.g., national ID, MRN) - required for patient lookup"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "family",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-family",
              "type": "string",
              "documentation": "Patient family name"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "given",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-given",
              "type": "string",
              "documentation": "Patient given name"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "birthdate",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
              "type": "date",
              "documentation": "Patient date of birth"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "Practitioner",
          "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.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read Practitioner by logical ID"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "Organization",
          "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.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read Organization by logical ID"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "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.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read Condition by logical ID"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search for Condition resources"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "The patient who has the condition (SHALL support)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "clinical-status",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
              "type": "token",
              "documentation": "The clinical status of the condition"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/Condition-category",
              "type": "token",
              "documentation": "The category of condition"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type": "token",
              "documentation": "Code for the condition"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "AllergyIntolerance",
          "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.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read AllergyIntolerance by logical ID"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search for AllergyIntolerance resources"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "The patient who has the allergy or intolerance (SHALL support)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "clinical-status",
              "definition": "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status",
              "type": "token",
              "documentation": "The clinical status of the allergy or intolerance"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "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.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read Observation by logical ID"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search for Observation resources"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "The patient the observation is about (SHALL support)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/Observation-category",
              "type": "token",
              "documentation": "Category of observation (e.g., vital-signs, laboratory)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type": "token",
              "documentation": "The code of the observation type"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type": "date",
              "documentation": "Obtained date/time. Date modifiers ge, le, gt, lt SHOULD be supported."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/Observation-status",
              "type": "token",
              "documentation": "The status of the observation"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "DiagnosticReport",
          "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.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read DiagnosticReport by logical ID"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search for DiagnosticReport resources"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "The patient the report is about (SHALL support)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-category",
              "type": "token",
              "documentation": "Category of report (e.g., LAB, RAD)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-code",
              "type": "token",
              "documentation": "The code for the report type"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type": "date",
              "documentation": "The clinically relevant time of the report"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/DiagnosticReport-status",
              "type": "token",
              "documentation": "The status of the report"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "MedicationRequest",
          "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.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read MedicationRequest by logical ID"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search for MedicationRequest resources"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "The patient for whom the medication was ordered (SHALL support)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/medications-status",
              "type": "token",
              "documentation": "Status of the prescription"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "intent",
              "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-intent",
              "type": "token",
              "documentation": "The intent of the medication request"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "authoredon",
              "definition": "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon",
              "type": "date",
              "documentation": "Return prescriptions written on this date"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "MedicationDispense",
          "documentation": "MedicationDispense resources represent medication dispensing events.\nIf supported, clients SHALL support search by patient.\nClients MAY omit this resource based on their needs.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read MedicationDispense by logical ID"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search for MedicationDispense resources"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "The patient for whom the medication was dispensed (SHALL support)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/medications-status",
              "type": "token",
              "documentation": "Status of the dispense"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "whenhandedover",
              "definition": "http://hl7.org/fhir/SearchParameter/MedicationDispense-whenhandedover",
              "type": "date",
              "documentation": "When the medication was handed over"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "Encounter",
          "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.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read Encounter by logical ID"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search for Encounter resources"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "The patient present at the encounter (SHALL support)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type": "date",
              "documentation": "A date within the encounter period"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/Encounter-status",
              "type": "token",
              "documentation": "Status of the encounter"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "class",
              "definition": "http://hl7.org/fhir/SearchParameter/Encounter-class",
              "type": "token",
              "documentation": "Classification of the encounter (e.g., inpatient, outpatient)"
            }
          ]
        }
      ]
    }
  ]
}

FHIR IG analytics

Resources that use this resource

Resources that this resource uses

Narrative

EEHRxF Resource Consumer CapabilityStatement

FHIR RESTful Capabilities

Mode: client

Resource Flexibility

Scopes for Desired Resources

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL Patient

Resource Conformance: SHOULD Practitioner

Resource Conformance: SHOULD Organization

Resource Conformance: SHOULD Condition

Resource Conformance: SHOULD AllergyIntolerance

Resource Conformance: SHOULD Observation

Resource Conformance: SHOULD DiagnosticReport

Resource Conformance: SHOULD MedicationRequest

Resource Conformance: SHOULD MedicationDispense

Resource Conformance: SHOULD Encounter

Source1

Mode: `client`