International Patient Summary Implementation Guide
2.0.0 - 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.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 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

Generated Narrative: CapabilityStatement ips-server

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
  • 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:
  AllergyIntolerance (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:
  DeviceUseStatement (IPS)
DiagnosticReporthttp://hl7.org/fhir/StructureDefinition/DiagnosticReport
Additional supported profiles:
  DiagnosticReport (IPS)
ImagingStudyhttp://hl7.org/fhir/StructureDefinition/ImagingStudy
Additional supported profiles:
  ImagingStudy (IPS)
Immunizationhttp://hl7.org/fhir/StructureDefinition/Immunization
Additional supported profiles:
  Immunization (IPS)
Medicationhttp://hl7.org/fhir/StructureDefinition/Medication
Additional supported profiles:
  Medication (IPS)
MedicationRequesthttp://hl7.org/fhir/StructureDefinition/MedicationRequest
Additional supported profiles:
  MedicationRequest (IPS)
MedicationStatementhttp://hl7.org/fhir/StructureDefinition/MedicationStatement
Additional supported profiles:
  MedicationStatement (IPS)
Observationhttp://hl7.org/fhir/StructureDefinition/Observation
Additional supported profiles:
  Observation Pregnancy - Expected Delivery Date (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)
  
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)
Flaghttp://hl7.org/fhir/StructureDefinition/Flag
Additional supported profiles:
  Flag - Alert (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

Base System Profile
Bundle
Profile Conformance
SHALL
Reference Policy

Supported Profiles

Bundle (IPS)

Interaction summary

    Resource Conformance: supported Composition

    Base System Profile
    Composition
    Profile Conformance
    SHALL
    Reference Policy

    Supported Profiles

    Composition (IPS)

    Interaction summary

      Resource Conformance: supported Patient

      Base System Profile
      Patient
      Profile Conformance
      SHALL
      Reference Policy

      Supported Profiles

      Patient (IPS)

      Interaction summary

        Extended Operations
        ConformanceOperationDocumentation
        SHOULD$summary

        Resource Conformance: supported AllergyIntolerance

        Base System Profile
        AllergyIntolerance
        Profile Conformance
        SHALL
        Reference Policy

        Supported Profiles

        AllergyIntolerance (IPS)

        Interaction summary

          Resource Conformance: supported Condition

          Base System Profile
          Condition
          Profile Conformance
          SHALL
          Reference Policy

          Supported Profiles

          Condition (IPS)

          Interaction summary

            Resource Conformance: supported Device

            Base System Profile
            Device
            Profile Conformance
            SHALL
            Reference Policy

            Supported Profiles

            Device (IPS)

            Interaction summary

              Resource Conformance: supported DeviceUseStatement

              Base System Profile
              DeviceUseStatement
              Profile Conformance
              SHALL
              Reference Policy

              Supported Profiles

              DeviceUseStatement (IPS)

              Interaction summary

                Resource Conformance: supported DiagnosticReport

                Base System Profile
                DiagnosticReport
                Profile Conformance
                SHALL
                Reference Policy

                Supported Profiles

                DiagnosticReport (IPS)

                Interaction summary

                  Resource Conformance: supported ImagingStudy

                  Base System Profile
                  ImagingStudy
                  Profile Conformance
                  SHALL
                  Reference Policy

                  Supported Profiles

                  ImagingStudy (IPS)

                  Interaction summary

                    Resource Conformance: supported Immunization

                    Base System Profile
                    Immunization
                    Profile Conformance
                    SHALL
                    Reference Policy

                    Supported Profiles

                    Immunization (IPS)

                    Interaction summary

                      Resource Conformance: supported Medication

                      Base System Profile
                      Medication
                      Profile Conformance
                      SHALL
                      Reference Policy

                      Supported Profiles

                      Medication (IPS)

                      Interaction summary

                        Resource Conformance: supported MedicationRequest

                        Base System Profile
                        MedicationRequest
                        Profile Conformance
                        SHALL
                        Reference Policy

                        Supported Profiles

                        MedicationRequest (IPS)

                        Interaction summary

                          Resource Conformance: supported MedicationStatement

                          Base System Profile
                          MedicationStatement
                          Profile Conformance
                          SHALL
                          Reference Policy

                          Supported Profiles

                          MedicationStatement (IPS)

                          Interaction summary

                            Resource Conformance: supported Organization

                            Base System Profile
                            Organization
                            Profile Conformance
                            SHALL
                            Reference Policy

                            Supported Profiles

                            Organization (IPS)

                            Interaction summary

                              Resource Conformance: supported Practitioner

                              Base System Profile
                              Practitioner
                              Profile Conformance
                              SHALL
                              Reference Policy

                              Supported Profiles

                              Practitioner (IPS)

                              Interaction summary

                                Resource Conformance: supported PractitionerRole

                                Base System Profile
                                PractitionerRole
                                Profile Conformance
                                SHALL
                                Reference Policy

                                Supported Profiles

                                PractitionerRole (IPS)

                                Interaction summary

                                  Resource Conformance: supported Flag

                                  Base System Profile
                                  Flag
                                  Profile Conformance
                                  SHALL
                                  Reference Policy

                                  Supported Profiles

                                  Flag - Alert (IPS)

                                  Interaction summary

                                    Resource Conformance: supported Procedure

                                    Base System Profile
                                    Procedure
                                    Profile Conformance
                                    SHALL
                                    Reference Policy

                                    Supported Profiles

                                    Procedure (IPS)

                                    Interaction summary

                                      Resource Conformance: supported Specimen

                                      Base System Profile
                                      Specimen
                                      Profile Conformance
                                      SHALL
                                      Reference Policy

                                      Supported Profiles

                                      Specimen (IPS)

                                      Interaction summary

                                        Resource Conformance: SHOULD DocumentReference

                                        Base System Profile
                                        DocumentReference
                                        Profile Conformance
                                        SHALL
                                        Reference Policy

                                        Interaction summary

                                          Extended Operations
                                          ConformanceOperationDocumentation
                                          SHOULD$docref

                                          Resource Conformance: SHOULD OperationDefinition

                                          Base System Profile
                                          OperationDefinition
                                          Profile Conformance
                                          SHALL
                                          Reference Policy

                                          Interaction summary