Query for Existing Data for Mobile (QEDm)
3.0.0-comment1 - ballot International flag

This page is part of the Query for Existing Data for Mobile (QEDm) (v3.0.0-comment1: Publication Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

CapabilityStatement: IHE QEDm Clinical Data Source Actor

Official URL: https://profiles.ihe.net/PCC/QEDm/CapabilityStatement/IHE.QEDm.Clinical-Data-Source Version: 3.0.0-comment1
Active as of 2024-07-17 Computable Name: IHE_QEDm_Clinical_Data_Source

CapabilityStatement for Clinical Data Source Actor.

The Clinical Data Source in this profile responds to FHIR-based queries for one or more fine-grained data elements (FHIR resources) defined by the options listed in Section 8.2 QEDm Actor Options.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement IHE.QEDm.Clinical-Data-Source

IHE QEDm Clinical Data Source Actor

  • Implementation Guide Version: 3.0.0-comment1
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support application/fhir+json, SHOULD support application/fhir+xml
  • Supported Patch Formats: SHOULDsupport application/json-patch+json
  • Published on: 2024-07-17
  • Published by: IHE Patient Care Coordination Technical Committee

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: server

The Clinical Data Source in this profile responds to FHIR-based queries for one or more fine-grained data elements (FHIR resources) defined by the options listed in Section 8.2 QEDm Actor Options.

Security

Recommend ATNA, encouraged IHE-IUA or SMART-app-launch

Summary of System-wide Interactions

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 TypeProfileRSUCSearches_include_revincludeOperations
AllergyIntolerance yypatientProvenance:target
Condition yycategory, clinical-status, patient, patient+clinical-status, patient+categoryProvenance:target
Immunization yypatientProvenance:target
Medication yypatientProvenance:target
MedicationRequest yypatientMedicationRequest:medicationProvenance:target
MedicationStatement yypatientMedicationStatement:medicationProvenance:target
ObservationSupported Profiles
  Vital Signs Profile
  Combat Zone Period
  Employment Status
  Occupational Data For Health
  Past Or Present Job
  Retirement Date
  Usual Work		yycategory, code, date, status, patient, patient+category, patient+code, patient+category+date, patient+code+dateProvenance:target
DiagnosticReport yycategory, code, date, patient, patient+category, patient+category+code, patient+category+date, patient+category+code+dateProvenance:target
Procedure yydate, patient, patient+dateProvenance:target
Encounter yydate, patient, patient+dateProvenance:target

Resource Conformance: SHOULD AllergyIntolerance

Core FHIR Resource
AllergyIntolerance
Reference Policy
resolves
Interaction summary
  • SHALLsupport read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
 

Resource Conformance: SHOULD Condition

Core FHIR Resource
Condition
Reference Policy
resolves
Interaction summary
  • SHALLsupport read, search-type.

Documentation

Client applications should be prepared to encounter codes they do not recognize and handle the records accordingly. Servers SHOULD populate Condition.code.coding.display and/or Condition.code.text so that clients can always at least display the condition even if they do not know the codes that are used. Clients should be careful making use of the code search parameter given that the codes used vary so much.

Safety Issues:

  • Clients SHALL not treat all conditions as if they are part of the patient's current problem list
    • Note that some Condition resources may not have these status codes - this is usually due to poor record keeping reflected in legacy data
    • Servers SHOULD avoid leaving these status codes missing
  • Clients SHALL pay attention to the clinicalStatus and verificationStatus and display and process them correctly
  • Clients SHALL still work safely when the server does not support all the search parameters listed here.
Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHOULDcategorytoken

The category of the condition

SHOULDclinical-statustoken

The clinical status of the condition

Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+clinical-statusreference+token
SHOULDpatient+categoryreference+token

Resource Conformance: SHOULD Immunization

Core FHIR Resource
Immunization
Reference Policy
resolves
Interaction summary
  • SHALLsupport read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
 

Resource Conformance: SHOULD Medication

Core FHIR Resource
Medication
Reference Policy
resolves
Interaction summary
  • SHALLsupport read, search-type.

Documentation

The MedicationStatement and MedicationRequest resources can represent a medication, using an external reference to a Medication resource. If an external Medication Resource is used in a MedicationStatement or a MedicationRequest, then the READ and SEARCH Criteria SHALL be supported.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
 

Resource Conformance: SHOULD MedicationRequest

Core FHIR Resource
MedicationRequest
Reference Policy
resolves
Interaction summary
  • SHALLsupport read, search-type.

Documentation

Clients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.

The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be contained or an external resource. The server application MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the _include parameter for searching this element. The client application SHALL support all methods. For example, A server SHALL be capable of returning all medications for a patient using one of or both:

GET /MedicationStatement?patient=[id]

GET /MedicationStatement?patient=[id]&_include=MedicationStatement:medication

When representing a prescribed medication, servers SHOULD use codings at the level of a clinical drug rather than ingredient or dose form (e.g. "loratadine 10mg oral tablet", rather than a bare ingredient like "loratadine" or a dose form like "loratadine oral tablet").

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
 

Resource Conformance: SHOULD MedicationStatement

Core FHIR Resource
MedicationStatement
Reference Policy
resolves
Interaction summary
  • SHALLsupport read, search-type.

Documentation

Clients SHALL query for both MedicationStatement and MedicationRequest when fetching patient Medication information.

The MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing Medication, the resource may be contained or an external resource. The server application MAY choose any one way or more than one method, but if an external reference to Medication is used, the server SHALL support the _include parameter for searching this element. The client application SHALL support all methods.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
 

Resource Conformance: SHOULD Observation

Core FHIR Resource
Observation
Reference Policy
resolves
Interaction summary
  • SHALLsupport read, search-type.

Supported Profiles

http://hl7.org/fhir/StructureDefinition/vitalsigns
https://profiles.ihe.net/PCC/ODH/StructureDefinition/odh-CombatZonePeriod
https://profiles.ihe.net/PCC/ODH/StructureDefinition/odh-EmploymentStatus
https://profiles.ihe.net/PCC/ODH/StructureDefinition/odh-OccupationalDataForHealth
https://profiles.ihe.net/PCC/ODH/StructureDefinition/odh-PastOrPresentJob
https://profiles.ihe.net/PCC/ODH/StructureDefinition/odh-RetirementDate
https://profiles.ihe.net/PCC/ODH/StructureDefinition/odh-UsualWork

Search Parameters
ConformanceParameterTypeDocumentation
MAYcategorytoken

The classification of the type of observation

MAYcodetoken

The code of the observation type

MAYdatedate

Obtained date/time. If the obtained element is a period, a date that falls in the period. The date modifiers ge,le,gt,lt SHALL be supported.

MAYstatustoken

The status of the observation

MAYpatientreference

The Clinical Data Consumer SHALL support at least one of the search parameters combinations.

Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+categoryreference+token
SHALLpatient+codereference+token
SHALLpatient+category+datereference+token+date
SHOULDpatient+code+datereference+token+date

Resource Conformance: SHOULD DiagnosticReport

Core FHIR Resource
DiagnosticReport
Reference Policy
resolves
Interaction summary
  • SHALLsupport read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcategorytoken

The classification of the type of observation

SHALLcodetoken

The code of the observation type

SHALLdatedate

Obtained date/time. If the obtained element is a period, a date that falls in the period. The date modifiers ge,le,gt,lt SHALL be supported.

SHALLpatientreference
Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+categoryreference+token
SHALLpatient+category+codereference+token+token
SHALLpatient+category+datereference+token+date
SHOULDpatient+category+code+datereference+token+token+date

Resource Conformance: SHOULD Procedure

Core FHIR Resource
Procedure
Reference Policy
resolves
Interaction summary
  • SHALLsupport read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate

Obtained date/time. If the obtained element is a period, a date that falls in the period. The date modifiers ge,le,gt,lt SHALL be supported.

SHALLpatientreference
Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+datereference+date

Resource Conformance: SHOULD Encounter

Core FHIR Resource
Encounter
Reference Policy
resolves
Interaction summary
  • SHALLsupport read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate

Obtained date/time. If the obtained element is a period, a date that falls in the period. The date modifiers ge,le,gt,lt SHALL be supported.

SHALLpatientreference
Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+datereference+date