CapabilityStatement-ipa-client

Sourcehl7.fhir.uv.ipa#current:International Patient Access (v4.0.1)
resourceTypeCapabilityStatement
idipa-client
canonicalhttp://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-client
version1.0.0
statusactive
publisherHL7 International - Patient Care Work Group
nameInternationalPatientAccessClientAPI
titleInternational Patient Access Client CapabilityStatement
date2022-12-08
experimentalfalse
descriptionThis CapabilityStatement describes the basic rules for the International Patient Access client actor that initiates a data access request to and retrieves patient data from an IPA Responder. In addition, it lists the client conformance expectations for each resource type documented in IPA. These expectations include supported FHIR profiles, RESTful operations, and search parameters. International Patient Access clients define their capabilities by choosing from this list based on the resource types they need to access.
copyrightUsed by permission of HL7 International all rights reserved Creative Commons License
jurisdictionsuv
kindrequirements
fhirVersion4.0.1
formatsjson xml application/json-patch+json
implementationGuideshttp://hl7.org/fhir/smart-app-launch/ImplementationGuide/hl7.fhir.uv.smart-app-launch
Usages(none)

InternationalPatientAccessClientAPI

This CapabilityStatement describes the basic rules for the International Patient Access client actor that initiates a data access request to and retrieves patient data from an IPA Responder. In addition, it lists the client conformance expectations for each resource type documented in IPA. These expectations include supported FHIR profiles, RESTful operations, and search parameters. International Patient Access clients define their capabilities by choosing from this list based on the resource types they need to access.

Mode CLIENT
Description

The IPA Client SHALL :

  1. Support the IPA conformance expectations for the Patient resource profile.
  2. Support the IPA conformance expectations for each IPA resource type they support
  3. Implement the RESTful behavior according to the FHIR specification.
  4. Support JSON source formats for all IPA interactions.

The IPA Client SHOULD :

  1. For the purposes of safety, specify the patient id when searching other resources.
Transaction y
System History y
System Search y
Resource Type Profile Read Search Update Create
AllergyIntolerance http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-allergyintolerance y y
Condition http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-condition
Additional supported profiles:
   IPA-problem-list-item 		y y
DocumentReference http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference y y
Immunization http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization y y
Medication http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication y
MedicationRequest http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest y y
MedicationStatement http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationstatement y y
Observation http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-observation
Additional supported profiles:
   Vital Signs Profile 		y y
Patient http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient y y
Practitioner http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner y
PractitionerRole http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole y

Produced 08 Sep 2023