International Patient Access
1.1.0 - STU1

International Patient Access, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ipa/ and changes regularly. See the Directory of published versions

## IPA ImplementationGuide Resource

Page standards status: Informative

Official URL: http://hl7.org/fhir/uv/ipa/ImplementationGuide/hl7.fhir.uv.ipa | Version: 1.0.0
NPM package name: hl7.fhir.uv.ipa | ComputableName: InternationalPatientAccess
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |

This IG describes how an application acting on behalf of a patient can access information about the patient from an clinical records system using a FHIR based API. The clinical records system may be supporting a clinical care provider (e.g. a hospital, or a general practitioner), or a health data exchange, including a national health record system.

- XML
- JSON

### Cross Version Analysis

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (hl7.fhir.uv.ipa.r4) and R4B (hl7.fhir.uv.ipa.r4b) are available.

### IG Dependencies

This IG Contains the following dependencies on other IGs.

IG | Package | FHIR | Comment
--- | --- | --- | ---
International Patient Access | hl7.fhir.uv.ipa#1.1.0 | R4 |
HL7 Terminology (THO) | hl7.terminology.r4#6.2.0 | R4 | Automatically added as a dependency - all IGs depend on HL7 Terminology
FHIR Extensions Pack | hl7.fhir.uv.extensions.r4#5.2.0 | R4 | Automatically added as a dependency - all IGs depend on the HL7 Extension Pack
SMART App Launch | hl7.fhir.uv.smart-app-launch#2.0.0 | R4 |

Package hl7.fhir.uv.extensions.r4#5.2.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Mon, Feb 10, 2025 21:45+1100+11:00)

### Global Profiles

There are no Global profiles defined

### Copyrights

This publication includes IP covered under the following statements.

- The UCUM codes, UCUM table (regardless of format), and UCUM Specification are copyright 1999-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. https://ucum.org/trac/wiki/TermsOfUse
  Show Usage
  - Unified Code for Units of Measure (UCUM): Immunization/ImmExample1, Medication/MedExample1... Show 5 more, MedicationRequest/MedRecExample1, MedicationStatement/MedStatementExample1, Observation/LabExample1, Observation/SmokingExample1 and Observation/VitalSignsExample1
- This material contains content from LOINC. LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.
  Show Usage
  - LOINC: DocumentReference/USClinicalNoteExample1, IPAFetchDocumentReference, Observation/LabExample1, Observation/SmokingExample1 and Observation/VitalSignsExample1
- This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
  Show Usage
  - SNOMED Clinical Terms&reg; (SNOMED CT&reg;): AllergyIntolerance/NKAExample, Condition/EncounterExample1... Show 7 more, Condition/ProblemExample1, Immunization/ImmExample1, Medication/MedExample1, MedicationRequest/MedRecExample1, MedicationStatement/MedStatementExample1, Observation/SmokingExample1 and PractitionerRole/PractitionerRoleExample1
- This material derives from the HL7 Terminology (THO). THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html
  Show Usage
  - AllergyIntolerance Clinical Status Codes: AllergyIntolerance/AllIntExample1 and AllergyIntolerance/NKAExample
  - AllergyIntolerance Verification Status: AllergyIntolerance/AllIntExample1 and AllergyIntolerance/NKAExample
  - Condition Category Codes: Condition/EncounterExample1, Condition/ProblemExample1 and IPAProblemListItem
  - Condition Clinical Status Codes: Condition/EncounterExample1 and Condition/ProblemExample1
  - ConditionVerificationStatus: Condition/EncounterExample1 and Condition/ProblemExample1
  - DoseAndRateType: MedicationRequest/MedRecExample1 and MedicationStatement/MedStatementExample1
  - Medication request administration location codes: MedicationRequest/MedRecExample1
  - Observation Category Codes: Observation/LabExample1, Observation/SmokingExample1 and Observation/VitalSignsExample1
  - Practitioner role: PractitionerRole/PractitionerRoleExample1
  - identifierType: Patient/PatientExample1
  - providerRole: Immunization/ImmExample1
  - ActSite: Immunization/ImmExample1
  - MaritalStatus: Patient/PatientExample1
  - ObservationInterpretation: Observation/LabExample1
  - RouteOfAdministration: Immunization/ImmExample1
  - Orderable Drug Form: Medication/MedExample1
- Unless otherwise noted, the contents of the FDA website (www.fda.gov) — both text and graphics — are not copyrighted. They are in the public domain and may be republished, reprinted and otherwise used freely by anyone without the need to obtain permission from FDA. Credit to the U.S. Food and Drug Administration as the source is appreciated but not required.
  Show Usage
  - Unique Ingredient Identifier (UNII): AllergyIntolerance/AllIntExample1
- Using RxNorm codes of type SAB=RXNORM as this specification describes does not require a UMLS license. Access to the full set of RxNorm definitions, and/or additional use of other RxNorm structures and information requires a UMLS license. The use of RxNorm in this specification is pursuant to HL7's status as a licensee of the NLM UMLS. HL7's license does not convey the right to use RxNorm to any users of this specification; implementers must acquire a license to use RxNorm in their own right.
  Show Usage
  - RxNorm: AllergyIntolerance/AllIntExample1 and Medication/MedExample1

### Parameter Settings

The following IG Parameters are set for this Implementation Guide:

- code: copyrightyear
  value: 2022+
- code: releaselabel
  value: STU1
- code: path-resource
  value: input/resources
- code: path-resource
  value: fsh-generated/resources
- code: path-pages
  value: input/pagecontent
- code: path-pages
  value: input/intro-notes
- code: path-pages
  value: fsh-generated/includes
- code: apply-contact
  value: true
- code: apply-jurisdiction
  value: true
- code: apply-publisher
  value: true
- code: apply-version
  value: true
- code: show-inherited-invariants
  value: false
- code: usage-stats-opt-out
  value: true
- code: excludexml
  value: false
- code: excludejson
  value: false
- code: excludettl
  value: true
- code: excludemap
  value: true
- code: generate
  value: xml
- code: generate
  value: json
- code: logging
  value: progress
- code: logging
  value: tx
- code: logging
  value: context
- code: logging
  value: init
- code: path-history
  value: http://hl7.org/fhir/uv/ipa/history.html