International Patient Summary Implementation Guide
2.0.0 - STU 2

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

## CapabilityStatement: IPS Server Capability Statement

Official URL: http://hl7.org/fhir/uv/ips/CapabilityStatement/ips-server | Version: 2.0.0
Standards status: Trial-use | Maturity Level: 2 | Computable Name: IpsServerCapabilityStatement
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

This CapabilityStatement describes the expected capabilities of the IPS Server actor which is responsible for providing responses to the queries submitted for IPS documents. The list of FHIR profiles and operations supported by IPS Servers are defined in this CapabilityStatement.

Raw OpenAPI-Swagger Definition file | Download

## IPS Server Capability Statement

- Implementation Guide Version: 2.0.0
- FHIR Version: 4.0.1
- Supported Formats: `application/fhir+xml`, `xml`, `application/fhir+json`, `json`
- Published on: 2022-01-05 13:15:56+0000
- Published by: HL7 International / Patient Care

> Note to Implementers: FHIR Capabilities

> Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

## FHIR RESTful Capabilities

### Mode: `server`

### 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, recommended, and some optional search parameters (if any).
- The linked resources enabled for `_include`
- The other resources enabled for `_revinclude`
- The operations on the resource (if any)

Resource Type | Profile | R | S | U | C | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Bundle | Supported Profiles Bundle (IPS) |  |  |  |  |  |  |  |
Composition | Supported Profiles Composition (IPS) |  |  |  |  |  |  |  |
Patient | Supported Profiles Patient (IPS) |  |  |  |  |  |  |  | `$summary`
AllergyIntolerance | Supported Profiles AllergyIntolerance (IPS) |  |  |  |  |  |  |  |
Condition | Supported Profiles Condition (IPS) |  |  |  |  |  |  |  |
MedicationRequest | Supported Profiles MedicationRequest (IPS) |  |  |  |  |  |  |  |
MedicationStatement | Supported Profiles MedicationStatement (IPS) |  |  |  |  |  |  |  |
CarePlan |  |  |  |  |  |  |  |  |
ClinicalImpression |  |  |  |  |  |  |  |  |
Consent |  |  |  |  |  |  |  |  |
Device | Supported Profiles Device (IPS) Device - Performer or Observer (IPS) |  |  |  |  |  |  |  |
DeviceUseStatement | Supported Profiles DeviceUseStatement (IPS) |  |  |  |  |  |  |  |
DiagnosticReport | Supported Profiles DiagnosticReport (IPS) |  |  |  |  |  |  |  |
DocumentReference |  |  |  |  |  |  |  |  | `$docref`
Flag | Supported Profiles Flag - Alert (IPS) |  |  |  |  |  |  |  |
ImagingStudy | Supported Profiles ImagingStudy (IPS) |  |  |  |  |  |  |  |
Immunization | Supported Profiles Immunization (IPS) |  |  |  |  |  |  |  |
ImmunizationRecommendation |  |  |  |  |  |  |  |  |
Medication | Supported Profiles Medication (IPS) |  |  |  |  |  |  |  |
MedicationAdministration |  |  |  |  |  |  |  |  |
MedicationDispense |  |  |  |  |  |  |  |  |
Observation | Supported Profiles Observation Pregnancy - Expected Delivery Date (IPS) Observation Pregnancy - Outcome (IPS) Observation Pregnancy - Status (IPS) Observation Social History - Alcohol Use (IPS) Observation Social History - Tobacco Use (IPS) Observation Results - Laboratory/Pathology (IPS) Observation Results - Radiology (IPS) Observation Respiratory Rate Profile Observation Heart Rate Profile Observation Oxygen Saturation Profile Observation Body Temperature Profile Observation Body Height Profile Observation Head Circumference Profile Observation Body Weight Profile Observation Body Mass Index Profile Observation Blood Pressure Profile |  |  |  |  |  |  |  |
Organization | Supported Profiles Organization (IPS) |  |  |  |  |  |  |  |
Practitioner | Supported Profiles Practitioner (IPS) |  |  |  |  |  |  |  |
PractitionerRole | Supported Profiles PractitionerRole (IPS) |  |  |  |  |  |  |  |
Procedure | Supported Profiles Procedure (IPS) |  |  |  |  |  |  |  |
RelatedPerson |  |  |  |  |  |  |  |  |
Specimen | Supported Profiles Specimen (IPS) |  |  |  |  |  |  |  |

#### Resource Conformance: SHALL Bundle

Core FHIR Resource
Bundle
Reference Policy
Interaction summary

Supported Profiles

Bundle (IPS)

#### Resource Conformance: SHALL Composition

Core FHIR Resource
Composition
Reference Policy
Interaction summary

Supported Profiles

Composition (IPS)

#### Resource Conformance: SHALL Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary

Supported Profiles

Patient (IPS)

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHOULD | $summary |

#### Resource Conformance: SHOULD AllergyIntolerance

Core FHIR Resource
AllergyIntolerance
Reference Policy
Interaction summary

Supported Profiles

AllergyIntolerance (IPS)

#### Resource Conformance: SHOULD Condition

Core FHIR Resource
Condition
Reference Policy
Interaction summary

Supported Profiles

Condition (IPS)

#### Resource Conformance: SHOULD MedicationRequest

Core FHIR Resource
MedicationRequest
Reference Policy
Interaction summary

Supported Profiles

MedicationRequest (IPS)

Documentation

> Some systems may only support MedicationRequest(IPS) or MedicationStatement(IPS).

#### Resource Conformance: SHOULD MedicationStatement

Core FHIR Resource
MedicationStatement
Reference Policy
Interaction summary

Supported Profiles

MedicationStatement (IPS)

Documentation

> Some systems may only support MedicationRequest(IPS) or MedicationStatement(IPS).

#### Resource Conformance: MAY CarePlan

Core FHIR Resource
CarePlan
Reference Policy
Interaction summary

#### Resource Conformance: MAY ClinicalImpression

Core FHIR Resource
ClinicalImpression
Reference Policy
Interaction summary

#### Resource Conformance: MAY Consent

Core FHIR Resource
Consent
Reference Policy
Interaction summary

#### Resource Conformance: MAY Device

Core FHIR Resource
Device
Reference Policy
Interaction summary

Supported Profiles

Device (IPS)
Device - Performer or Observer (IPS)

#### Resource Conformance: MAY DeviceUseStatement

Core FHIR Resource
DeviceUseStatement
Reference Policy
Interaction summary

Supported Profiles

DeviceUseStatement (IPS)

#### Resource Conformance: MAY DiagnosticReport

Core FHIR Resource
DiagnosticReport
Reference Policy
Interaction summary

Supported Profiles

DiagnosticReport (IPS)

#### Resource Conformance: SHOULD DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHOULD | $docref |

#### Resource Conformance: MAY Flag

Core FHIR Resource
Flag
Reference Policy
Interaction summary

Supported Profiles

Flag - Alert (IPS)

#### Resource Conformance: MAY ImagingStudy

Core FHIR Resource
ImagingStudy
Reference Policy
Interaction summary

Supported Profiles

ImagingStudy (IPS)

#### Resource Conformance: MAY Immunization

Core FHIR Resource
Immunization
Reference Policy
Interaction summary

Supported Profiles

Immunization (IPS)

#### Resource Conformance: MAY ImmunizationRecommendation

Core FHIR Resource
ImmunizationRecommendation
Reference Policy
Interaction summary

#### Resource Conformance: MAY Medication

Core FHIR Resource
Medication
Reference Policy
Interaction summary

Supported Profiles

Medication (IPS)

#### Resource Conformance: MAY MedicationAdministration

Core FHIR Resource
MedicationAdministration
Reference Policy
Interaction summary

#### Resource Conformance: MAY MedicationDispense

Core FHIR Resource
MedicationDispense
Reference Policy
Interaction summary

#### Resource Conformance: MAY Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary

Supported Profiles

Observation Pregnancy - Expected Delivery Date (IPS)
Observation Pregnancy - Outcome (IPS)
Observation Pregnancy - Status (IPS)
Observation Social History - Alcohol Use (IPS)
Observation Social History - Tobacco Use (IPS)
Observation Results - Laboratory/Pathology (IPS)
Observation Results - Radiology (IPS)
Observation Respiratory Rate Profile
Observation Heart Rate Profile
Observation Oxygen Saturation Profile
Observation Body Temperature Profile
Observation Body Height Profile
Observation Head Circumference Profile
Observation Body Weight Profile
Observation Body Mass Index Profile
Observation Blood Pressure Profile

#### Resource Conformance: MAY Organization

Core FHIR Resource
Organization
Reference Policy
Interaction summary

Supported Profiles

Organization (IPS)

#### Resource Conformance: MAY Practitioner

Core FHIR Resource
Practitioner
Reference Policy
Interaction summary

Supported Profiles

Practitioner (IPS)

#### Resource Conformance: MAY PractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary

Supported Profiles

PractitionerRole (IPS)

#### Resource Conformance: MAY Procedure

Core FHIR Resource
Procedure
Reference Policy
Interaction summary

Supported Profiles

Procedure (IPS)

#### Resource Conformance: MAY RelatedPerson

Core FHIR Resource
RelatedPerson
Reference Policy
Interaction summary

#### Resource Conformance: MAY Specimen

Core FHIR Resource
Specimen
Reference Policy
Interaction summary

Supported Profiles

Specimen (IPS)