International Patient Access
1.0.0-preview - STU1

International Patient Access - Local Development build (v1.0.0-preview). 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 a International Patient Access API

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

IPA-MedicationStatement

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

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

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 Server CapabilityStatement

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.

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.

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

  • start date
  • end date
  • document type

and returns a Bundle of type “searchset” containing DocumentReference resources for the patient. If the server has or can create documents that are related to the patient, and that are available for the given user, the server returns the DocumentReference resources needed to support the records. The principle intended use for this operation is to provide a patient with access to their available document information.

This operation is different from a search by patient and type and date range because:

  1. It is used to request a server 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 (depending on jurisdiction)

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

This operation is the same as a FHIR RESTful search by patient, type and date range because:

  1. References for existing documents that meet the requirements of the request SHOULD also be returned unless the client indicates they are only interested in ‘on-demand’ documents using the on-demand parameter.

Example: Example Instances

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

AllIntExample1
IPA Condition Example

This is a problem list item example for the IPA Condition 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.

VitalSignsExample1
IPA Patient Example

This is a Patient example for the IPA Patient Profile.

PatientGenderExample1
Practitioner Example

This is a Practitioner example for the IPA Practitioner Profile.

PractitionerRole Example

This is a PractitionerRole example for the IPA PractitionerRole Profile.