Release 4 Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

Using Codes Code Systems Value Sets Concept Maps Identifier Systems 4.4.1.353 Value Set http://hl7.org/fhir/ValueSet/measure-improvement-notation

Example OperationDefinition/Composition-document (JSON)

Committee:
Clinical Quality Information Structured Documents Work Group   Maturity Level : 2 N/A Trial Use Use Context Standards Status : Any This is a value set defined by the FHIR project. Summary Defining URL: http://hl7.org/fhir/ValueSet/measure-improvement-notation Version: 4.0.1 Name: MeasureImprovementNotation Title: MeasureImprovementNotation Definition: Informative Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue.
  4.4.1.353.2 Expansion This expansion generated 01 Nov 2019 This value set contains 2 concepts Expansion based on http://terminology.hl7.org/CodeSystem/measure-improvement-notation version 4.0.1

All codes from system http://terminology.hl7.org/CodeSystem/measure-improvement-notation Code Display Definition increase Raw JSON Increased score indicates improvement Improvement is indicated as an increase in the score or measurement (e.g. Higher score indicates better quality). ( canonical form decrease + also see JSON Format Specification Decreased score indicates improvement Improvement is indicated as a decrease in the score or measurement (e.g. Lower score indicates better quality).   )

See the full registry of value sets defined as part of FHIR. Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "Composition-document",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/Composition/$document</p><p>URL: [base]/Composition/[id]/$document</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>id</td><td>0..1</td><td><a href=\"datatypes.html#uri\">uri</a></td><td/><td><div><p>Identifies the composition to use. This can either be a simple id, which identifies a composition, or it can be a full URL, which identifies a composition on another server.</p>\n<p>Notes:</p>\n<ul>\n<li>GET [base]/Composition/[id]/$document is identical in meaning to GET [base]/Composition/$document?id=[id]</li>\n<li>the id parameter SHALL NOT be used if the operation is requested on a particular composition (e.g.  GET [base]/Composition/[id]/$document?id=[id] is not allowed)</li>\n<li>Servers are not required to support generating documents on Compositions located on another server</li>\n</ul>\n</div></td></tr><tr><td>IN</td><td>persist</td><td>0..1</td><td><a href=\"datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Whether to store the document at the bundle end-point (/Bundle) or not once it is generated. Value = true or false (default is for the server to decide). If the document is stored, it's location can be inferred from the Bundle.id, but it SHOULD be provided explicitly in the HTTP Location header in the response</p>\n</div></td></tr><tr><td>IN</td><td>graph</td><td>0..1</td><td><a href=\"datatypes.html#uri\">uri</a></td><td/><td><div><p>Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a <a href=\"graphdefinition.html\">GraphDefinition</a> that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources</p>\n</div></td></tr></table><div><p>Notes:</p>\n<ul>\n<li>The server implementing the operation SHOULD determine a 'high-level water-mark' for the document security tags (<a href=\"resource.html#Meta\">Bundle.meta.security</a>)) as a whole, based on an analysis of the resources contained within the document</li>\n<li>this operation definition does not resolve the question how document signatures are created. This is an open issue during the period of trial use, and feedback is requested regarding this question</li>\n</ul>\n</div></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 2
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  }],
  "url" : "http://hl7.org/fhir/OperationDefinition/Composition-document",
  "version" : "5.0.0-snapshot3",
  "name" : "Document",
  "title" : "Generate a Document",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2022-12-14T07:12:54+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "A client can ask a server to generate a fully bundled document from a composition resource. The server takes the composition resource, locates all the referenced resources and other additional resources as configured or requested and either returns a full document bundle, or returns an error. Note that since this is a search operation, the document bundle is  wrapped inside the search bundle.  If some of the resources are located on other servers, it is at the discretion of the  server whether to retrieve them or return an error. If the correct version of the document  that would be generated already exists, then the server can return the existing one.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "affectsState" : false,
  "code" : "document",
  "comment" : "Notes:\n\n* The server implementing the operation SHOULD determine a 'high-level water-mark' for the document security tags ([Bundle.meta.security](resource.html#Meta))) as a whole, based on an analysis of the resources contained within the document\n* this operation definition does not resolve the question how document signatures are created. This is an open issue during the period of trial use, and feedback is requested regarding this question",
  "resource" : ["Composition"],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [{
    "name" : "id",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "Identifies the composition to use. This can either be a simple id, which identifies a composition, or it can be a full URL, which identifies a composition on another server. \n\nNotes: \n\n* GET [base]/Composition/[id]/$document is identical in meaning to GET [base]/Composition/$document?id=[id]\n* the id parameter SHALL NOT be used if the operation is requested on a particular composition (e.g.  GET [base]/Composition/[id]/$document?id=[id] is not allowed)\n* Servers are not required to support generating documents on Compositions located on another server",
    "type" : "uri"
  },
  {
    "name" : "persist",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "Whether to store the document at the bundle end-point (/Bundle) or not once it is generated. Value = true or false (default is for the server to decide). If the document is stored, it's location can be inferred from the Bundle.id, but it SHOULD be provided explicitly in the HTTP Location header in the response",
    "type" : "boolean"
  },
  {
    "name" : "graph",
    "use" : "in",
    "min" : 0,
    "max" : "1",
    "documentation" : "Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition](graphdefinition.html) that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources",
    "type" : "uri"
  }]
}

Explanation of the columns that may appear on this page: Lvl A few code lists that FHIR defines are hierarchical - each code is assigned a level. For value sets, levels are mostly used Usage note: every effort has been made to organize codes for user convenience, but may follow code system hierarchy - see Code System for further information Source The source of the definition of the code (when the value set draws in codes defined elsewhere) Code The code (used as the code in the resource instance). If the code is in italics, this indicates ensure that the code is examples are correct and useful, but they are not selectable ('Abstract') Display The display (used in the display element of a Coding ). If there is no display, implementers should not simply display the code, but map the concept into their application Definition An explanation of the meaning normative part of the concept Comments Additional notes about how to use the code specification.