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/uv/ips/StructureDefinition/Bundle-uv-ips
Compositionhttp://hl7.org/fhir/uv/ips/StructureDefinition/Composition-uv-ips
Patienthttp://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips$summary
AllergyIntoleranceSupported Profiles
  AllergyIntolerance (IPS)
ConditionSupported Profiles
  Condition (IPS)
MedicationRequestSupported Profiles
  MedicationRequest (IPS)
MedicationStatementSupported Profiles
  MedicationStatement (IPS)
CarePlan 
ClinicalImpression 
Consent 
DeviceSupported Profiles
  Device (IPS)
DeviceUseStatementSupported Profiles
  DeviceUseStatement (IPS)
DocumentReferenceSupported Profiles
  DiagnosticReport (IPS)
$docref
FlagSupported Profiles
  Flag - Alert (IPS)
ImagingStudySupported Profiles
  ImagingStudy (IPS)
ImmunizationSupported Profiles
  Immunization (IPS)
MedicationSupported Profiles
  Medication (IPS)
MedicationAdministration 
MedicationDispense 
ObservationSupported 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
OrganizationSupported Profiles
  Organization (IPS)
PractitionerSupported Profiles
  Practitioner (IPS)
PractitionerRoleSupported Profiles
  PractitionerRole (IPS)
ProcedureSupported Profiles
  Procedure (IPS)
RelatedPerson 
SpecimenSupported Profiles
  Specimen (IPS)

Resource Conformance: SHALL Bundle

Base System Profile
Bundle (IPS)
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Resource Conformance: SHALL Composition

    Base System Profile
    Composition (IPS)
    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary

      Resource Conformance: SHALL Patient

      Base System Profile
      Patient (IPS)
      Profile Conformance
      SHALL
      Reference Policy

      Interaction summary

        Extended Operations
        ConformanceOperationDocumentation
        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)

                        Resource Conformance: MAY DeviceUseStatement

                        Core FHIR Resource
                        DeviceUseStatement
                        Reference Policy
                        Interaction summary

                          Supported Profiles

                          DeviceUseStatement (IPS)

                          Resource Conformance: MAY DocumentReference

                          Core FHIR Resource
                          DocumentReference
                          Reference Policy
                          Interaction summary

                            Supported Profiles

                            DiagnosticReport (IPS)

                            Extended Operations
                            ConformanceOperationDocumentation
                            MAY$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 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 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)