International Patient Access
0.1.0 - STU 1 ballot

This page is part of the International Patient Access (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

CapabilityStatement: International Patient Access Server CapabilityStatement

Raw OpenAPI-Swagger Definition file | Download

International Patient Access Server CapabilityStatement

  • Official URL: http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-server
  • Official name: InternationalPatientAccessAPI
  • Implementation Guide Version: 0.8.0
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support json, SHOULD support xml
  • Supported Patch Formats: SHOULD support application/json-patch+json
  • Published on: Tue Nov 23 00:00:00 CST 2021
  • Published by: HL7 International - Patient Care Workgroup

This section describes the basic rules for the International Patient Access server actor that is responsible for providing responses to queries submitted by International Patient Access requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by International Patient Access servers are defined in this CapabilityStatement. International Patient Access clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.

SHOULD Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

The IPA Server SHALL:

  1. Support the IPA Patient resource profile.
  2. Support at least one additional resource profile from the list of IPA Profiles.
  3. Implement the RESTful behavior according to the FHIR specification.
  4. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scope
    • (Status 404): unknown resource
    • (Status 410): deleted resource.
  5. Support JSON source formats for all IPA interactions.
  6. Declare a CapabilityStatement identifying the list of profiles, operations, and search parameters supported.

The IPA Server SHOULD:

  1. Support XML source formats for all IPA interactions.
  2. Identify the IPA profiles supported as part of the FHIR meta.profile attribute for each instance.
Security
  1. See the General Security Considerations section for requirements and recommendations.
  2. A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.
Summary of System-wide Interactions
  • MAY support the transaction interaction.
  • MAY support the batch interaction.
  • MAY support the search-system interaction.
  • MAY support the history-system interaction.

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 or recommended 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
AllergyIntolerancehttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintoleranceyypatient, patient+clinical-statusProvenance:target
Conditionhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-conditionyypatient, patient+clinical-status, patient+category, patient+category+clinical-status, patient+code, patient+onset-dateProvenance:target
DocumentReferencehttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreferenceyy_id, patient, patient+category, patient+category+date, patient+type, patient+contenttype, patient+status, patient+type+date, patient+type+periodProvenance:target$docref
Immunizationhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunizationyypatient, patient+date, patient+statusProvenance:target
Medicationhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationyProvenance:target
MedicationRequesthttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequestyycategory, code, patient, patient+intent, patient+intent+authoredon, patient+intent+statusMedicationRequest:medicationProvenance:target
MedicationStatementhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatementyysubject, subject+statusMedicationRequest:medicationProvenance:target
Observationhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation
Additional supported profiles:
  http://hl7.org/fhir/StructureDefinition/vitalsigns		yypatient, patient+category, patient+code, patient+category+date, patient+category+status, patient+code+dateProvenance:target
Patienthttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patientyy_id, birthdate, family, gender, given, identifier, name, family+gender, birthdate+family, birthdate+name, gender+nameProvenance:target
Practitionerhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioneryProvenance:target
PractitionerRolehttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerroleyPractitionerRole:endpoint, PractitionerRole:practitionerProvenance:target

AllergyIntolerance

Conformance expectation: SHOULD
Reference policy: resolves

Base System Profile

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance

Interaction summary
  • SHALL support read, search-type.
Search Parameters
ConformanceParameterType
SHALLpatientreference
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+clinical-statusreference+token
Search Parameter Documentation
patient of type reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.

clinical-status of type token

active | inactive | resolved

Condition

Conformance expectation: SHOULD
Reference policy: resolves

Base System Profile

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition

Interaction summary
  • SHALL support read, search-type.
Search Parameters
ConformanceParameterType
SHALLpatientreference
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+clinical-statusreference+token
SHOULDpatient+categoryreference+token
SHOULDpatient+category+clinical-statusreference+token+token
SHOULDpatient+codereference+token
SHOULDpatient+onset-datereference+date
Search Parameter Documentation
code of type token

Code for the condition

patient of type reference

The client SHALL provide at least a id value and MAY provide both the Type and id values.

The server SHALL support both.

clinical-status of type token

The clinical status of the condition

category of type token

The category of the condition

onset-date of type date

Date of onset for the condition

DocumentReference

Conformance expectation: SHOULD
Reference policy: resolves

Base System Profile

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference

Interaction summary
  • SHALL support read, search-type.
Search Parameters
ConformanceParameterType
SHALL_idtoken
SHALLpatientreference
Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+categoryreference+token
SHALLpatient+category+datereference+token+date
SHALLpatient+typereference+token
SHOULDpatient+contenttypereference+token
SHOULDpatient+statusreference+token
SHOULDpatient+type+datereference+token+date
SHOULDpatient+type+periodreference+token+date
Search Parameter Documentation
date of type date

When this document reference was created

period of type date

Time of service that is being documented

patient of type reference

The client SHALL provide at least an id value and MAY provide both the Type and id values.

The server SHALL support both.

category of type token

Categorization of document

type of type token

Kind of document (LOINC if possible)

contenttype of type token

Mime type of the content, may include charset

status of type token

current | superseded | entered-in-error

Immunization

Conformance expectation: SHOULD
Reference policy: resolves

Base System Profile

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization

Interaction summary
  • SHALL support read, search-type.
Search Parameters
ConformanceParameterType
SHALLpatientreference
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+datereference+date
SHOULDpatient+statusreference+token
Search Parameter Documentation
date of type date

Vaccination (non)-Administration Date

patient of type reference

The client SHALL provide at least an id value and MAY provide both the Type and id values.

The server SHALL support both.

status of type token

Immunization event status

Medication

Conformance expectation: SHOULD
Reference policy: resolves

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.

Base System Profile

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication

Interaction summary
  • SHALL support read.

MedicationRequest

Conformance expectation: SHOULD
Reference policy: resolves

Base System Profile

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest

Interaction summary
  • SHALL support read, search-type.
Search Parameters
ConformanceParameterType
SHALLpatientreference
SHOULDcategorytoken
SHOULDcodetoken
Combined Search Parameters
ConformanceParametersTypes
SHOULDpatient+intentreference+token
SHOULDpatient+intent+authoredonreference+token+date
SHOULDpatient+intent+statusreference+token+token
Search Parameter Documentation
code of type token

Return prescriptions of this medication code

authoredon of type date

Returns prescriptions written on this date

patient of type reference

The client SHALL provide at least an id value and MAY provide both the Type and id values.

The server SHALL support both.

category of type token

Returns prescriptions with different categories

intent of type token

Return prescriptions with this encounter identifier

status of type token

Status of the prescription

MedicationStatement

Conformance expectation: SHOULD
Reference policy: resolves

Documentation

The MedicationStatement 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 must support all methods.

For example, A server SHALL be capable of returning all medications for a patient using one of or both:

GET /MedicationRequest?patient=[id]

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

Base System Profile

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement

Interaction summary
  • SHALL support read, search-type.
Search Parameters
ConformanceParameterType
SHALLsubjectreference
Combined Search Parameters
ConformanceParametersTypes
SHOULDsubject+statusreference+token
Search Parameter Documentation
subject of type reference

Return statements that match the given status

status of type token

Return statements that match the given status

Observation

Conformance expectation: SHOULD
Reference policy: resolves

Base System Profile

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation

Supported Profiles

http://hl7.org/fhir/StructureDefinition/vitalsigns

Interaction summary
  • SHALL support read, search-type.
Search Parameters
ConformanceParameterType
SHALLpatientreference
Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+categoryreference+token
SHALLpatient+codereference+token
SHALLpatient+category+datereference+token+date
SHOULDpatient+category+statusreference+token+token
SHOULDpatient+code+datereference+token+date
Search Parameter Documentation
date of type date

Obtained date/time. If the obtained element is a period, a date that falls in the period

code of type token

The code of the observation type

patient of type reference

The client SHALL provide at least an id value and MAY provide both the Type and id values.

The server SHALL support both.

category of type token

The classification of the type of observation

status of type token

The status of the observation

Patient

Conformance expectation: SHALL
Reference policy: resolves

Base System Profile

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient

Interaction summary
  • SHALL support read, search-type.
Search Parameters
ConformanceParameterType
SHALL_idtoken
SHALLidentifiertoken
SHOULDbirthdatedate
SHOULDfamilystring
SHOULDgendertoken
SHOULDgivenstring
SHOULDnamestring
Combined Search Parameters
ConformanceParametersTypes
SHOULDfamily+genderstring+token
SHOULDbirthdate+familydate+string
SHOULDbirthdate+namedate+string
SHOULDgender+nametoken+string
Search Parameter Documentation
identifier of type token

The client SHALL provide both the system and code values.

The server SHALL NOT support only code values.

birthdate of type date

A client SHALL provide a value precise to the day.

A server SHALL support a value a value precise to the day.

gender of type token

The client SHALL provide at least a code value and MAY provide both the system and code values.

The server SHALL support both.

family of type string

A server SHALL support a value precise to the day.

Practitioner

Conformance expectation: SHOULD
Reference policy: resolves

Base System Profile

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner

Interaction summary
  • SHALL support read.

PractitionerRole

Conformance expectation: SHOULD
Reference policy: resolves

Base System Profile

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole

Interaction summary
  • SHALL support read.