International Patient Summary Implementation Guide
1.1.0 - CI Build International flag

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 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-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: 1.1.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 section 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.

Raw OpenAPI-Swagger Definition file | Download

IPS Server Capability Statement

  • Implementation Guide Version: 1.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, xml, application/fhir+json, json
  • Supported Patch Formats:
  • 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

Summary of System-wide Interactions

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 TypeProfileRSUCSearches_include_revincludeOperations
Bundlehttp://hl7.org/fhir/StructureDefinition/Bundle
Additional supported profiles:
  Bundle - IPS
Compositionhttp://hl7.org/fhir/StructureDefinition/Composition
Additional supported profiles:
  Composition (IPS)
Patienthttp://hl7.org/fhir/StructureDefinition/Patient
Additional supported profiles:
  Patient (IPS)
$summary
AllergyIntolerancehttp://hl7.org/fhir/StructureDefinition/AllergyIntolerance
Additional supported profiles:
  Allergy Intolerance (IPS)
Conditionhttp://hl7.org/fhir/StructureDefinition/Condition
Additional supported profiles:
  Condition (IPS)
Devicehttp://hl7.org/fhir/StructureDefinition/Device
Additional supported profiles:
  Device (IPS)
DeviceUseStatementhttp://hl7.org/fhir/StructureDefinition/DeviceUseStatement
Additional supported profiles:
  Device Use Statement (IPS)
DiagnosticReporthttp://hl7.org/fhir/StructureDefinition/DiagnosticReport
Additional supported profiles:
  DiagnosticReport (IPS)
ImagingStudyhttp://hl7.org/fhir/StructureDefinition/ImagingStudy
Additional supported profiles:
  Imaging Study (IPS)
Immunizationhttp://hl7.org/fhir/StructureDefinition/Immunization
Additional supported profiles:
  Immunization (IPS)
Mediahttp://hl7.org/fhir/StructureDefinition/Media
Additional supported profiles:
  Media observation (Results: laboratory, media)
Medicationhttp://hl7.org/fhir/StructureDefinition/Medication
Additional supported profiles:
  Medication (IPS)
MedicationRequesthttp://hl7.org/fhir/StructureDefinition/MedicationRequest
Additional supported profiles:
  Medication Request (IPS)
MedicationStatementhttp://hl7.org/fhir/StructureDefinition/MedicationStatement
Additional supported profiles:
  Medication Statement (IPS)
Observationhttp://hl7.org/fhir/StructureDefinition/Observation
Additional supported profiles:
  Observation - Pregnancy: EDD
  Observation - Pregnancy: status
  Observation - SH: alcohol use
  Observation - SH: tobacco use
  Observation Results (IPS)
  Observation Results: laboratory (IPS)
  Observation Results: pathology (IPS)
Organizationhttp://hl7.org/fhir/StructureDefinition/Organization
Additional supported profiles:
  Organization (IPS)
Practitionerhttp://hl7.org/fhir/StructureDefinition/Practitioner
Additional supported profiles:
  Practitioner (IPS)
PractitionerRolehttp://hl7.org/fhir/StructureDefinition/PractitionerRole
Additional supported profiles:
  PractitionerRole (IPS)
Procedurehttp://hl7.org/fhir/StructureDefinition/Procedure
Additional supported profiles:
  Procedure (IPS)
Specimenhttp://hl7.org/fhir/StructureDefinition/Specimen
Additional supported profiles:
  Specimen (IPS)
DocumentReferencehttp://hl7.org/fhir/StructureDefinition/DocumentReference$docref
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinition

Resource Conformance: supported Bundle

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported Composition

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported Patient

Profile Conformance
SHALL
Reference Policy

Extended Operations
ConformanceOperationDocumentation
SHOULD$summary

Resource Conformance: supported AllergyIntolerance

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported Condition

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported Device

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported DeviceUseStatement

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported DiagnosticReport

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported ImagingStudy

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported Immunization

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported Media

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported Medication

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported MedicationRequest

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported MedicationStatement

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported Organization

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported Practitioner

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported PractitionerRole

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported Procedure

Profile Conformance
SHALL
Reference Policy

Resource Conformance: supported Specimen

Profile Conformance
SHALL
Reference Policy

Resource Conformance: SHOULD DocumentReference

Profile Conformance
SHALL
Reference Policy

Interaction summary

    Extended Operations
    ConformanceOperationDocumentation
    SHOULD$docref

    Resource Conformance: SHOULD OperationDefinition

    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary