FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server  |  FHIR Version n/a  User: [n/a]

Resource OperationDefinition/FHIR Server from package hl7.fhir.uv.ips#current (32 ms)

Package hl7.fhir.uv.ips
Type OperationDefinition
Id Id
FHIR Version R4
Source http://hl7.org/fhir/uv/ips/https://build.fhir.org/ig/HL7/fhir-ips/OperationDefinition-summary.html
Url http://hl7.org/fhir/uv/ips/OperationDefinition/summary
Version 2.0.0-ballot
Status active
Date 2022-01-05T13:15:56.964-00:00
Name IpsSummary
Title IPS Summary
Experimental False
Realm uv
Authority hl7
Description This operation is used to return a patient summary using the IPS profile.
Type true
Kind operation

Resources that use this resource

CapabilityStatement
ips-server IPS Server Capability Statement

Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition summary

URL: [base]/Patient/$summary

URL: [base]/Patient/[id]/$summary

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INidentifier0..1string
(token)

When the logical id of the patient is not used, servers MAY choose to support patient selection based on provided identifier

INprofile0..1uri

A specific profile for the patient summary may be specified. By default, servers MAY use the Bundle profile

INgraph0..1uri

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

OUTreturn0..1Bundle

The Bundle returned is a document conforming to the specified input profile parameter or the International Patient Summary Bundle profile (if not otherwise specified)


Source

{
  "resourceType" : "OperationDefinition",
  "id" : "summary",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition summary</b></p><a name=\"summary\"> </a><a name=\"hcsummary\"> </a><a name=\"hcsummary-en-US\"> </a><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>Scope</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>identifier</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</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>\n</div></td></tr><tr><td>IN</td><td>profile</td><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>\n</div></td></tr><tr><td>IN</td><td>graph</td><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>\n</div></td></tr><tr><td>OUT</td><td>return</td><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>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "pc"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 2,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/ips/ImplementationGuide/hl7.fhir.uv.ips"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/ips/ImplementationGuide/hl7.fhir.uv.ips"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/uv/ips/OperationDefinition/summary",
  "version" : "2.0.0-ballot",
  "name" : "IpsSummary",
  "title" : "IPS Summary",
  "status" : "active",
  "kind" : "operation",
  "date" : "2022-01-05T13:15:56.964-00:00",
  "publisher" : "HL7 International / Patient Care",
  "contact" : [
    {
      "name" : "HL7 International / Patient Care",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/patientcare"
        }
      ]
    }
  ],
  "description" : "This operation is used to return a patient summary using the IPS profile.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "summary",
  "resource" : [
    "Patient"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "identifier",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "When the logical id of the patient is not used, servers MAY choose to support patient selection based on provided identifier",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "profile",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "A specific profile for the patient summary may be specified. By default, servers MAY use the [Bundle profile](./StructureDefinition-Bundle-uv-ips.html)",
      "type" : "uri"
    },
    {
      "name" : "graph",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "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" : "uri"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "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" : "Bundle"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.