International Patient Summary Implementation Guide
2.0.1 - STU 2 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 2.0.1 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.1
Standards status: Trial-use Maturity Level: 3 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

Language: en

IPS Server Capability Statement

  • Implementation Guide Version: 2.0.1
  • 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 TypeProfileRSUCSearches_include_revincludeOperations
BundleSupported Profiles
  Bundle (IPS)version: 2.0.1)
CompositionSupported Profiles
  Composition (IPS)version: 2.0.1)
PatientSupported Profiles
  Patient (IPS)version: 2.0.1)
$summary
AllergyIntoleranceSupported Profiles
  AllergyIntolerance (IPS)version: 2.0.1)
ConditionSupported Profiles
  Condition (IPS)version: 2.0.1)
MedicationRequestSupported Profiles
  MedicationRequest (IPS)version: 2.0.1)
MedicationStatementSupported Profiles
  MedicationStatement (IPS)version: 2.0.1)
CarePlan 
ClinicalImpression 
Consent 
DeviceSupported Profiles
  Device (IPS)version: 2.0.1)
  Device - Performer or Observer (IPS)version: 2.0.1)
DeviceUseStatementSupported Profiles
  DeviceUseStatement (IPS)version: 2.0.1)
DiagnosticReportSupported Profiles
  DiagnosticReport (IPS)version: 2.0.1)
DocumentReference $docref
FlagSupported Profiles
  Flag - Alert (IPS)version: 2.0.1)
ImagingStudySupported Profiles
  ImagingStudy (IPS)version: 2.0.1)
ImmunizationSupported Profiles
  Immunization (IPS)version: 2.0.1)
ImmunizationRecommendation 
MedicationSupported Profiles
  Medication (IPS)version: 2.0.1)
MedicationAdministration 
MedicationDispense 
ObservationSupported Profiles
  Observation Pregnancy - Expected Delivery Date (IPS)version: 2.0.1)
  Observation Pregnancy - Outcome (IPS)version: 2.0.1)
  Observation Pregnancy - Status (IPS)version: 2.0.1)
  Observation Social History - Alcohol Use (IPS)version: 2.0.1)
  Observation Social History - Tobacco Use (IPS)version: 2.0.1)
  Observation Results - Laboratory/Pathology (IPS)version: 2.0.1)
  Observation Results - Radiology (IPS)version: 2.0.1)
  Observation Respiratory Rate Profileversion: 4.0.1)
  Observation Heart Rate Profileversion: 4.0.1)
  Observation Oxygen Saturation Profileversion: 4.0.1)
  Observation Body Temperature Profileversion: 4.0.1)
  Observation Body Height Profileversion: 4.0.1)
  Observation Head Circumference Profileversion: 4.0.1)
  Observation Body Weight Profileversion: 4.0.1)
  Observation Body Mass Index Profileversion: 4.0.1)
  Observation Blood Pressure Profileversion: 4.0.1)
OrganizationSupported Profiles
  Organization (IPS)version: 2.0.1)
PractitionerSupported Profiles
  Practitioner (IPS)version: 2.0.1)
PractitionerRoleSupported Profiles
  PractitionerRole (IPS)version: 2.0.1)
ProcedureSupported Profiles
  Procedure (IPS)version: 2.0.1)
RelatedPerson 
SpecimenSupported Profiles
  Specimen (IPS)version: 2.0.1)

Core FHIR Resource
Bundle
Reference Policy
Interaction summary

    Supported Profiles

    Bundle (IPS)version: 2.0.1)

    Core FHIR Resource
    Composition
    Reference Policy
    Interaction summary

      Core FHIR Resource
      Patient
      Reference Policy
      Interaction summary

        Extended Operations
        ConformanceOperationDocumentation
        SHOULD$summary
        Core FHIR Resource
        AllergyIntolerance
        Reference Policy
        Interaction summary

          Core FHIR Resource
          Condition
          Reference Policy
          Interaction summary

            Core FHIR Resource
            MedicationRequest
            Reference Policy
            Interaction summary

              Documentation

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

              Core FHIR Resource
              MedicationStatement
              Reference Policy
              Interaction summary

                Documentation

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

                Core FHIR Resource
                CarePlan
                Reference Policy
                Interaction summary

                  Core FHIR Resource
                  ClinicalImpression
                  Reference Policy
                  Interaction summary

                    Core FHIR Resource
                    Consent
                    Reference Policy
                    Interaction summary

                      Core FHIR Resource
                      DeviceUseStatement
                      Reference Policy
                      Interaction summary

                        Core FHIR Resource
                        DiagnosticReport
                        Reference Policy
                        Interaction summary

                          Core FHIR Resource
                          DocumentReference
                          Reference Policy
                          Interaction summary

                            Extended Operations
                            ConformanceOperationDocumentation
                            SHOULD$docref
                            Core FHIR Resource
                            Flag
                            Reference Policy
                            Interaction summary

                              Core FHIR Resource
                              ImagingStudy
                              Reference Policy
                              Interaction summary

                                Core FHIR Resource
                                Immunization
                                Reference Policy
                                Interaction summary

                                  Core FHIR Resource
                                  ImmunizationRecommendation
                                  Reference Policy
                                  Interaction summary

                                    Core FHIR Resource
                                    Medication
                                    Reference Policy
                                    Interaction summary

                                      Core FHIR Resource
                                      MedicationAdministration
                                      Reference Policy
                                      Interaction summary

                                        Core FHIR Resource
                                        MedicationDispense
                                        Reference Policy
                                        Interaction summary

                                          Core FHIR Resource
                                          Organization
                                          Reference Policy
                                          Interaction summary

                                            Core FHIR Resource
                                            Practitioner
                                            Reference Policy
                                            Interaction summary

                                              Core FHIR Resource
                                              PractitionerRole
                                              Reference Policy
                                              Interaction summary

                                                Core FHIR Resource
                                                Procedure
                                                Reference Policy
                                                Interaction summary

                                                  Core FHIR Resource
                                                  RelatedPerson
                                                  Reference Policy
                                                  Interaction summary

                                                    Core FHIR Resource
                                                    Specimen
                                                    Reference Policy
                                                    Interaction summary