International Patient Summary Implementation Guide
1.1.0 - STU 1 Update 1 International flag

This page is part of the International Patient Summary Implementation Guide (v1.1.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: IPS Summary - XML Representation

Page standards status: Trial-use Maturity Level: 2

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="summary"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/Patient/$summary</p><p>URL: [base]/Patient/[id]/$summary</p><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>identifer</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Identifier">Identifier</a></td><td/><td><div><p>When the logical id of the patient is not used, servers MAY choose to support patient selection based on provided identifier</p>
</div></td></tr><tr><td>IN</td><td>profile</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#uri">uri</a></td><td/><td><div><p>A specific profile for the patient summary may be specified. By default, servers MAY use the <a href="./StructureDefinition-Bundle-uv-ips.html">Bundle profile</a></p>
</div></td></tr><tr><td>IN</td><td>graph</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#uri">uri</a></td><td/><td><div><p>Servers MAY choose to allow any graph definition to be specified, but MAY require that the client choose a graph definition from a specific list of known supported definitions. The server is not required to support a formal definition of the graph on the end point</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>The Bundle returned is a document conforming to the specified input profile parameter or the International Patient Summary <a href="./StructureDefinition-Bundle-uv-ips.html">Bundle profile</a> (if not otherwise specified)</p>
</div></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="2">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/uv/ips/ImplementationGuide/ig-uv-ips"/>
      </extension>
    </valueInteger>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/uv/ips/ImplementationGuide/ig-uv-ips"/>
      </extension>
    </valueCode>
  </extension>
  <url value="http://hl7.org/fhir/uv/ips/OperationDefinition/summary"/>
  <version value="1.1.0"/>
  <name value="IpsSummary"/>
  <title value="IPS Summary"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2022-01-05T13:15:56.964-00:00"/>
  <publisher
             value="Health Level Seven International - Patient Care Work Group"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/patientcare"/>
    </telecom>
  </contact>
  <description
               value="This operation is used to return a patient summary using the IPS profile."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
    </coding>
  </jurisdiction>
  <affectsState value="false"/>
  <code value="summary"/>
  <resource value="Patient"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="identifer"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="When the logical id of the patient is not used, servers MAY choose to support patient selection based on provided identifier"/>
    <type value="Identifier"/>
  </parameter>
  <parameter>
    <name value="profile"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="A specific profile for the patient summary may be specified. By default, servers MAY use the [Bundle profile](./StructureDefinition-Bundle-uv-ips.html)"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="graph"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Servers MAY choose to allow any graph definition to be specified, but MAY require that the client choose a graph definition from a specific list of known supported definitions. The server is not required to support a formal definition of the graph on the end point"/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The Bundle returned is a document conforming to the specified input profile parameter or the International Patient Summary [Bundle profile](./StructureDefinition-Bundle-uv-ips.html) (if not otherwise specified)"/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>