International Patient Access
1.0.0 - STU1 International flag

International Patient Access, published by HL7 International - Patient Care Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-ipa/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Profiles: Primary Resources

Content Definitions for primary resources

IPA-AllergyIntolerance

Minimum expectations for an AllergyIntolerance resource when accessed via a International Patient Access API

IPA-Condition

Minimum expectations for a Condition resource when accessed via an International Patient Access API. This profile communicates information about a patient’s condition or diagnosis, such as recording primary and secondary diagnoses for encounters or justification for past medications. For the use of the condition resource to get a list of the patient’s current problem list, use the IPA-Problem-List-Item profile instead. The difference between this profile and the IPA Problem List Item profile is that this profile does not specify or require a category.

IPA-DocumentReference

Minimum expectations for a DocumentReference resource when accessed via a International Patient Access API

IPA-Immunization

Minimum expectations for an Immunization resource when accessed via a International Patient Access API

IPA-MedicationRequest

Minimum expectations for a MedicationRequest resource when accessed via a International Patient Access API. The MedicationRequest resource represents an order or request for both supply of the medication and the instructions for administration of the medication to a patient.

IPA-MedicationStatement

Minimum expectations for a MedicationStatement resource when accessed via a International Patient Access API. The MedicationStatement resource represents all medications a patient is taking, be it those ordered by a clinician or reported by another organization, the patient or a caregiver.

IPA-Observation

Minimum expectations for an Observation resource when accessed via a International Patient Access API

IPA-Patient

Minimum expectations for a Patient resource when accessed via a International Patient Access API. This profile describes how applications fetch the Patient resource to check the patient identity and access basic demographics and other administrative information about the patient.

IPA-problem-list-item

Minimum expectations for a Condition resource for representing the patient’s problem list items. The most important and prominent use of the condition resource is to get a list of the patient’s current problem list. This Condition profile communicates information about a patient’s problems. For other uses for the Condition resource, such as recording primary and secondary diagnoses for encounters or justification for past medications, use the IPA-Condition profile instead. The difference between this profile and the IPA Condition profile is that this profile requires a mandatory category of ‘problem-list-item’.

Profiles: Supporting Resources

Content Definitions for supporting resources

IPA-Medication

Minimum expectations for a Medication resource when accessed via a International Patient Access API

IPA-Practitioner

Minimum expectations for a Practitioner resource when accessed via a International Patient Access API

IPA-PractitionerRole

Minimum expectations for a PractitionerRole resource when accessed via a International Patient Access API

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

International Patient Access Client CapabilityStatement

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.

International Patient Access Server CapabilityStatement

This CapabilityStatement 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.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

IPA Fetch DocumentReference

This operation is used to return all the references to documents related to a patient. It is invoked on a FHIR Server’s DocumentReference endpoint (e.g., [base]/DocumentReference/$docref) and operates across all DocumentReference instances.

The operation requires a patient id and takes the optional input parameters:

  • start date
  • end date
  • document type
  • on-demand
  • profile

and returns a searchset Bundle containing DocumentReference resources for the patient. If the server has stored documents or can create documents for the patient and those documents are available for the user, the server returns the DocumentReference resources associated with documents. This operation’s intended use is to provide a way for providers or patients to access their available documents. The document itself can be subsequently retrieved using the link provided in the DocumentReference.content.attachment.url element. The link could be a FHIR endpoint to a Binary Resource or some other document repository.

This operation is different from a FHIR RESTful query on DocumentReference by patient and type and date range because:

  1. It is used to request a server to generate a document based on the specified parameters.

  2. If no parameters are specified, the server SHALL return a DocumentReference to the patient’s most current summary document. The type of such summary document will depend on jurisdiction. For example, it may be a C-CDA CCD. It is expected that such a summary document will always exist or can be dynamically generated; however, a jurisdiction may define the outcome of the operation when such a document is missing.

  3. If the server cannot generate a document based on the specified parameters, the operation will return an empty search bundle.

Unless the client indicates they are only interested in ‘on-demand’ documents using the on-demand parameter, the server SHOULD return DocumentReference instances for existing documents that meet the request parameters In this regard, this operation is similar to a FHIR RESTful query.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

IPA AllergyIntolerance Example

This is an allergy intolerance example for the IPA AllergyIntolerance Profile.

IPA No Known Allergies AllergyIntolerance Example

This is an example AllergyIntolerance using a no-known-allergies code.

IPA Condition Example

This is am encounter diagnosis example for the IPA Condition Profile.

IPA Problem List Item Example

This is a problem list item example for the IPA Problem List Item Profile.

DocumentReference Example

This is a DocumentReference example for the IPA DocumentReference Profile.

IPA Immunization Example

This is an Immunization example for the IPA Immunization Profile.

Medication Example

This is a Medication example for the IPA Medication Profile.

MedicationRequest Example

This is a MedicationRequest example for the IPA MedicationRequest Profile.

MedicationStatement Example

This is a MedicationStatement example for the IPA MedicationStatement Profile.

Observation Lab Example

This is a Observation example for the IPA Observation Profile containing a lab result.

Observation social history smoking Example

This is a Observation example for the IPA Observation Profile.

Observation Vital Signs Example

This is a Observation example for the IPA Observation Profile containing the vital sign for body weight.

IPA Patient Example

This is a Patient example for the IPA Patient Profile.

Practitioner Example

This is a Practitioner example for the IPA Practitioner Profile.

PractitionerRole Example

This is a PractitionerRole example for the IPA PractitionerRole Profile.