{"openapi":"3.1.0","info":{"title":"FHIRsmith Terminology Server","version":"0.17.0","summary":"A FHIR terminology server (R5)","description":"A FHIR terminology server: code systems, value sets and concept maps, and the\nterminology operations on them - $expand, $validate-code, $lookup, $subsumes,\n$translate, and more. This describes an R5 endpoint; the server's R4 and R3 endpoints\nwork the same way, with the resources of that version.\n\nThe operations are the ones FHIR defines (see the [terminology\nservice](https://hl7.org/fhir/R5/terminology-service.html)), with the behaviour the\n[terminology ecosystem IG](https://build.fhir.org/ig/HL7/fhir-tx-ecosystem-ig/) asks of\nthe servers in the ecosystem. Each operation lists the parameters this server reads.\n\n**Requests.** An operation can be invoked with GET, with its parameters in the query, or\nwith POST, with a Parameters resource (`application/fhir+json`), or a form. Parameters\nwhose values are not primitives (a Coding, a resource) can only be sent in a Parameters\nresource.\n\n**Responses** are JSON by default; `application/fhir+xml` (or `_format=xml`) gets XML,\nand a browser (or `_format=html`) gets an HTML page. Only the JSON is described here.\nErrors are OperationOutcomes, and every issue (except information) has a tx-issue-type\ncode in `details.coding` and its message in `details.text`.\n\n**Schemas.** The resource schemas describe what this server handles and returns: it\ndoesn't reject content outside them (an extension with a Quantity value, say), but it\nisn't designed to do anything with it. They have the JSON `_x` elements (the id and\nextensions of a primitive) and modifierExtension wherever FHIR allows them. Contained\nresources are value sets, in a value set, only.\n\n**Caching.** A client that sends the same resources (`tx-resource`) with many requests\ncan keep them on the server with `$cache-control`, and then send the cache's id in the\n`X-Cache-Id` header.\n\n**Common parameters.** These are read by $expand, $validate-code, $lookup, $subsumes, $translate and $compare, as well as their own parameters:\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `tx-resource` | Resource | 0..* | A CodeSystem, ValueSet or ConceptMap the operation may need (e.g. a value set that the value set being expanded imports), used instead of any the server has with the same url and version (POST, in a Parameters resource, only) |\n| `cache-id` | `id` | 0..1 | A cache of tx-resources started with $cache-control (mode=start). Sending it in the `X-Cache-Id` header instead is preferred |\n| `system-version` | `canonical` | 0..* | The version of a code system to use when the value set (or the request) doesn't say: `system\\|version` |\n| `check-system-version` | `canonical` | 0..* | The version of a code system that must be used: `system\\|version`. It's an error if anything else would be |\n| `force-system-version` | `canonical` | 0..* | The version of a code system to use, whatever the value set (or the request) says: `system\\|version` |\n| `default-valueset-version` | `canonical` | 0..* | The version of a value set to use when a reference to it doesn't say: `url\\|version` |\n| `check-valueset-version` | `canonical` | 0..* | The version of a value set that must be used: `url\\|version` |\n| `force-valueset-version` | `canonical` | 0..* | The version of a value set to use, whatever the reference to it says: `url\\|version` |\n| `default-to-latest-version` | `boolean` | 0..1 | When no version is specified, use the latest the server has |\n| `displayLanguage` | `code` | 0..1 | The language(s) for displays, in the form of an HTTP Accept-Language (which is used if this isn't present) |\n| `useSupplement` | `canonical` | 0..* | A code system supplement to use, which must then be used (`url` or `url\\|version`) |\n| `profile` | Parameters | 0..1 | A Parameters resource holding more of these parameters (an expansion profile) (POST, in a Parameters resource, only) |\n| `no-cache` | `boolean` | 0..1 | Don't answer from a cached result |\n| `diagnostics` | `boolean` | 0..1 | Add the server's working to the response (for debugging; the format can change at any time) |\n","license":{"name":"BSD-3-Clause","url":"https://opensource.org/license/bsd-3-clause"}},"externalDocs":{"description":"The FHIR R5 terminology service","url":"https://hl7.org/fhir/R5/terminology-service.html"},"servers":[{"url":"/r5"}],"tags":[{"name":"Server","description":"What the server does, and operations on the server as a whole"},{"name":"CodeSystem","description":"Code systems, and $lookup, $validate-code and $subsumes"},{"name":"ValueSet","description":"Value sets, and $expand, $validate-code and $compare"},{"name":"ConceptMap","description":"Concept maps, and $translate"}],"paths":{"/metadata":{"get":{"tags":["Server"],"operationId":"metadata","summary":"The server's capabilities","description":"The CapabilityStatement, or with `mode=terminology`, the TerminologyCapabilities:\nthe code systems (and versions) the server has, and the expansion parameters it\nunderstands.\n","parameters":[{"name":"mode","in":"query","description":"`terminology` for the TerminologyCapabilities","schema":{"type":"string","enum":["terminology"]}},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"description":"The CapabilityStatement, or the TerminologyCapabilities","content":{"application/fhir+json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CapabilityStatement"},{"$ref":"#/components/schemas/TerminologyCapabilities"}]}}}}}}},"/$versions":{"get":{"tags":["Server"],"operationId":"versions","summary":"The FHIR versions of this endpoint","description":"The FHIR version this endpoint uses. With `Accept: application/fhir+json` the answer\nis a Parameters resource (`version` and `default`); otherwise, a simple JSON object.\n","responses":{"200":{"description":"The versions","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"type":"object","properties":{"versions":{"type":"array","items":{"type":"string"},"example":["5.0"]},"default":{"type":"string","example":"5.0"}},"required":["versions","default"]}}}}}}},"/CodeSystem":{"get":{"tags":["CodeSystem"],"operationId":"searchCodeSystem","summary":"Search CodeSystems","description":"Searches the CodeSystems the server has. Text matches are case insensitive and partial (contains), except url and system; all the parameters given must match.","parameters":[{"name":"_offset","in":"query","description":"Paging: where to start (0 based)","schema":{"type":"integer","minimum":0}},{"name":"_count","in":"query","description":"Paging: how many to return (at most 200, or 2000 with _elements)","schema":{"type":"integer","minimum":0}},{"name":"_elements","in":"query","description":"The elements to return (comma separated)","schema":{"type":"string"}},{"name":"_sort","in":"query","description":"The element to sort by (default id)","schema":{"type":"string"}},{"name":"_summary","in":"query","description":"`true`, `text`, `data`, `count` or `false`","schema":{"type":"string"}},{"name":"_total","in":"query","description":"`none` to leave out the total (default accurate)","schema":{"type":"string"}},{"name":"url","in":"query","description":"The canonical url (exact)","schema":{"type":"string"}},{"name":"version","in":"query","description":"The version (contains)","schema":{"type":"string"}},{"name":"content-mode","in":"query","description":"CodeSystem: the content mode (contains)","schema":{"type":"string"}},{"name":"date","in":"query","description":"The date (contains)","schema":{"type":"string"}},{"name":"description","in":"query","description":"The description (contains)","schema":{"type":"string"}},{"name":"supplements","in":"query","description":"CodeSystem: what it supplements (contains)","schema":{"type":"string"}},{"name":"identifier","in":"query","description":"An identifier (contains)","schema":{"type":"string"}},{"name":"jurisdiction","in":"query","description":"A jurisdiction: a code or display (contains)","schema":{"type":"string"}},{"name":"name","in":"query","description":"The name (contains)","schema":{"type":"string"}},{"name":"publisher","in":"query","description":"The publisher (contains)","schema":{"type":"string"}},{"name":"status","in":"query","description":"The status (contains)","schema":{"type":"string"}},{"name":"system","in":"query","description":"The canonical url (exact; the same as url)","schema":{"type":"string"}},{"name":"title","in":"query","description":"The title (contains)","schema":{"type":"string"}},{"name":"text","in":"query","description":"The title or description (contains)","schema":{"type":"string"}},{"name":"source-system","in":"query","description":"ConceptMap: the source code system","schema":{"type":"string"}},{"name":"target-system","in":"query","description":"ConceptMap: the target code system","schema":{"type":"string"}},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"description":"A searchset Bundle of CodeSystems","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/CodeSystemSearchBundle"}}}},"500":{"$ref":"#/components/responses/Outcome"}}}},"/CodeSystem/_search":{"post":{"tags":["CodeSystem"],"operationId":"searchCodeSystemPost","summary":"Search CodeSystems (POST)","description":"Searches the CodeSystems the server has. Text matches are case insensitive and partial (contains), except url and system; all the parameters given must match. The parameters are in a form body.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"_offset":{"type":"integer","minimum":0},"_count":{"type":"integer","minimum":0},"_elements":{"type":"string"},"_sort":{"type":"string"},"_summary":{"type":"string"},"_total":{"type":"string"},"url":{"type":"string"},"version":{"type":"string"},"content-mode":{"type":"string"},"date":{"type":"string"},"description":{"type":"string"},"supplements":{"type":"string"},"identifier":{"type":"string"},"jurisdiction":{"type":"string"},"name":{"type":"string"},"publisher":{"type":"string"},"status":{"type":"string"},"system":{"type":"string"},"title":{"type":"string"},"text":{"type":"string"},"source-system":{"type":"string"},"target-system":{"type":"string"}}}}}},"responses":{"200":{"description":"A searchset Bundle of CodeSystems","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/CodeSystemSearchBundle"}}}},"500":{"$ref":"#/components/responses/Outcome"}}}},"/CodeSystem/{id}":{"get":{"tags":["CodeSystem"],"operationId":"readCodeSystem","summary":"Read a CodeSystem","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"description":"The CodeSystem","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/CodeSystem"}}}},"404":{"$ref":"#/components/responses/Outcome","description":"There is no such resource"}}}},"/ValueSet":{"get":{"tags":["ValueSet"],"operationId":"searchValueSet","summary":"Search ValueSets","description":"Searches the ValueSets the server has. Text matches are case insensitive and partial (contains), except url and system; all the parameters given must match.","parameters":[{"name":"_offset","in":"query","description":"Paging: where to start (0 based)","schema":{"type":"integer","minimum":0}},{"name":"_count","in":"query","description":"Paging: how many to return (at most 200, or 2000 with _elements)","schema":{"type":"integer","minimum":0}},{"name":"_elements","in":"query","description":"The elements to return (comma separated)","schema":{"type":"string"}},{"name":"_sort","in":"query","description":"The element to sort by (default id)","schema":{"type":"string"}},{"name":"_summary","in":"query","description":"`true`, `text`, `data`, `count` or `false`","schema":{"type":"string"}},{"name":"_total","in":"query","description":"`none` to leave out the total (default accurate)","schema":{"type":"string"}},{"name":"url","in":"query","description":"The canonical url (exact)","schema":{"type":"string"}},{"name":"version","in":"query","description":"The version (contains)","schema":{"type":"string"}},{"name":"content-mode","in":"query","description":"CodeSystem: the content mode (contains)","schema":{"type":"string"}},{"name":"date","in":"query","description":"The date (contains)","schema":{"type":"string"}},{"name":"description","in":"query","description":"The description (contains)","schema":{"type":"string"}},{"name":"supplements","in":"query","description":"CodeSystem: what it supplements (contains)","schema":{"type":"string"}},{"name":"identifier","in":"query","description":"An identifier (contains)","schema":{"type":"string"}},{"name":"jurisdiction","in":"query","description":"A jurisdiction: a code or display (contains)","schema":{"type":"string"}},{"name":"name","in":"query","description":"The name (contains)","schema":{"type":"string"}},{"name":"publisher","in":"query","description":"The publisher (contains)","schema":{"type":"string"}},{"name":"status","in":"query","description":"The status (contains)","schema":{"type":"string"}},{"name":"system","in":"query","description":"The canonical url (exact; the same as url)","schema":{"type":"string"}},{"name":"title","in":"query","description":"The title (contains)","schema":{"type":"string"}},{"name":"text","in":"query","description":"The title or description (contains)","schema":{"type":"string"}},{"name":"source-system","in":"query","description":"ConceptMap: the source code system","schema":{"type":"string"}},{"name":"target-system","in":"query","description":"ConceptMap: the target code system","schema":{"type":"string"}},{"name":"source","in":"query","description":"Only those from this source (package)","schema":{"type":"string"}},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"description":"A searchset Bundle of ValueSets","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ValueSetSearchBundle"}}}},"500":{"$ref":"#/components/responses/Outcome"}}}},"/ValueSet/_search":{"post":{"tags":["ValueSet"],"operationId":"searchValueSetPost","summary":"Search ValueSets (POST)","description":"Searches the ValueSets the server has. Text matches are case insensitive and partial (contains), except url and system; all the parameters given must match. The parameters are in a form body.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"_offset":{"type":"integer","minimum":0},"_count":{"type":"integer","minimum":0},"_elements":{"type":"string"},"_sort":{"type":"string"},"_summary":{"type":"string"},"_total":{"type":"string"},"url":{"type":"string"},"version":{"type":"string"},"content-mode":{"type":"string"},"date":{"type":"string"},"description":{"type":"string"},"supplements":{"type":"string"},"identifier":{"type":"string"},"jurisdiction":{"type":"string"},"name":{"type":"string"},"publisher":{"type":"string"},"status":{"type":"string"},"system":{"type":"string"},"title":{"type":"string"},"text":{"type":"string"},"source-system":{"type":"string"},"target-system":{"type":"string"},"source":{"type":"string"}}}}}},"responses":{"200":{"description":"A searchset Bundle of ValueSets","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ValueSetSearchBundle"}}}},"500":{"$ref":"#/components/responses/Outcome"}}}},"/ValueSet/{id}":{"get":{"tags":["ValueSet"],"operationId":"readValueSet","summary":"Read a ValueSet","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"description":"The ValueSet","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ValueSet"}}}},"404":{"$ref":"#/components/responses/Outcome","description":"There is no such resource"}}}},"/ConceptMap":{"get":{"tags":["ConceptMap"],"operationId":"searchConceptMap","summary":"Search ConceptMaps","description":"Searches the ConceptMaps the server has. Text matches are case insensitive and partial (contains), except url and system; all the parameters given must match.","parameters":[{"name":"_offset","in":"query","description":"Paging: where to start (0 based)","schema":{"type":"integer","minimum":0}},{"name":"_count","in":"query","description":"Paging: how many to return (at most 200, or 2000 with _elements)","schema":{"type":"integer","minimum":0}},{"name":"_elements","in":"query","description":"The elements to return (comma separated)","schema":{"type":"string"}},{"name":"_sort","in":"query","description":"The element to sort by (default id)","schema":{"type":"string"}},{"name":"_summary","in":"query","description":"`true`, `text`, `data`, `count` or `false`","schema":{"type":"string"}},{"name":"_total","in":"query","description":"`none` to leave out the total (default accurate)","schema":{"type":"string"}},{"name":"url","in":"query","description":"The canonical url (exact)","schema":{"type":"string"}},{"name":"version","in":"query","description":"The version (contains)","schema":{"type":"string"}},{"name":"content-mode","in":"query","description":"CodeSystem: the content mode (contains)","schema":{"type":"string"}},{"name":"date","in":"query","description":"The date (contains)","schema":{"type":"string"}},{"name":"description","in":"query","description":"The description (contains)","schema":{"type":"string"}},{"name":"supplements","in":"query","description":"CodeSystem: what it supplements (contains)","schema":{"type":"string"}},{"name":"identifier","in":"query","description":"An identifier (contains)","schema":{"type":"string"}},{"name":"jurisdiction","in":"query","description":"A jurisdiction: a code or display (contains)","schema":{"type":"string"}},{"name":"name","in":"query","description":"The name (contains)","schema":{"type":"string"}},{"name":"publisher","in":"query","description":"The publisher (contains)","schema":{"type":"string"}},{"name":"status","in":"query","description":"The status (contains)","schema":{"type":"string"}},{"name":"system","in":"query","description":"The canonical url (exact; the same as url)","schema":{"type":"string"}},{"name":"title","in":"query","description":"The title (contains)","schema":{"type":"string"}},{"name":"text","in":"query","description":"The title or description (contains)","schema":{"type":"string"}},{"name":"source-system","in":"query","description":"ConceptMap: the source code system","schema":{"type":"string"}},{"name":"target-system","in":"query","description":"ConceptMap: the target code system","schema":{"type":"string"}},{"name":"source","in":"query","description":"Only those from this source (package)","schema":{"type":"string"}},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"description":"A searchset Bundle of ConceptMaps","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ConceptMapSearchBundle"}}}},"500":{"$ref":"#/components/responses/Outcome"}}}},"/ConceptMap/_search":{"post":{"tags":["ConceptMap"],"operationId":"searchConceptMapPost","summary":"Search ConceptMaps (POST)","description":"Searches the ConceptMaps the server has. Text matches are case insensitive and partial (contains), except url and system; all the parameters given must match. The parameters are in a form body.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"_offset":{"type":"integer","minimum":0},"_count":{"type":"integer","minimum":0},"_elements":{"type":"string"},"_sort":{"type":"string"},"_summary":{"type":"string"},"_total":{"type":"string"},"url":{"type":"string"},"version":{"type":"string"},"content-mode":{"type":"string"},"date":{"type":"string"},"description":{"type":"string"},"supplements":{"type":"string"},"identifier":{"type":"string"},"jurisdiction":{"type":"string"},"name":{"type":"string"},"publisher":{"type":"string"},"status":{"type":"string"},"system":{"type":"string"},"title":{"type":"string"},"text":{"type":"string"},"source-system":{"type":"string"},"target-system":{"type":"string"},"source":{"type":"string"}}}}}},"responses":{"200":{"description":"A searchset Bundle of ConceptMaps","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ConceptMapSearchBundle"}}}},"500":{"$ref":"#/components/responses/Outcome"}}}},"/ConceptMap/{id}":{"get":{"tags":["ConceptMap"],"operationId":"readConceptMap","summary":"Read a ConceptMap","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"description":"The ConceptMap","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ConceptMap"}}}},"404":{"$ref":"#/components/responses/Outcome","description":"There is no such resource"}}}},"/ValueSet/$expand":{"get":{"tags":["ValueSet"],"operationId":"expandValueSet","summary":"Expand a value set","description":"Returns the codes in a value set, as ValueSet.expansion. The value set is named by url (and valueSetVersion), or sent as valueSet; at the instance level it's the value set with that id.\n\nA POST can also send the ValueSet itself as the body, with any other parameters in the query.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The value set to expand (type level) |\n| `valueSetVersion` | `string` | 0..1 | Its version |\n| `valueSet` | ValueSet | 0..1 | The value set to expand, sent with the request (POST, in a Parameters resource, only) |\n| `filter` | `string` | 0..1 | Text to filter the codes by (matching display and designations; how is up to the code system) |\n| `count` | `integer` | 0..1 | Paging: the number of codes to return |\n| `offset` | `integer` | 0..1 | Paging: where to start (0 based) |\n| `limit` | `integer` | 0..1 | Upper bound on the size of the expansion; the operation fails as too-costly beyond it |\n| `activeOnly` | `boolean` | 0..1 | Leave out inactive codes |\n| `excludeNested` | `boolean` | 0..1 | Return a flat list, not a hierarchy |\n| `excludeNotForUI` | `boolean` | 0..1 | Leave out codes that aren't for choosing in a user interface (abstract codes) |\n| `excludePostCoordinated` | `boolean` | 0..1 | Leave out post-coordinated codes |\n| `includeDesignations` | `boolean` | 0..1 | Include the designations of each code |\n| `designation` | `string` | 0..* | A designation to include: `language`, or a `system\\|code` use |\n| `includeDefinition` | `boolean` | 0..1 | Include the definition of each code |\n| `property` | `string` | 0..* | A property to include for each code |\n| `sort` | `string` | 0..1 | `code`, `display`, `design` or `prop:{name}`; prefix with - to reverse. Ignored for hierarchical expansions |\n| `versionsMatch` | `boolean` | 0..1 | Treat a code as the same code in different versions of its code system |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"url","in":"query","description":"The value set to expand (type level)","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"valueSetVersion","in":"query","description":"Its version","schema":{"type":"string","x-fhir-type":"string"}},{"name":"filter","in":"query","description":"Text to filter the codes by (matching display and designations; how is up to the code system)","schema":{"type":"string","x-fhir-type":"string"}},{"name":"count","in":"query","description":"Paging: the number of codes to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Paging: where to start (0 based)","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Upper bound on the size of the expansion; the operation fails as too-costly beyond it","schema":{"type":"integer"}},{"name":"activeOnly","in":"query","description":"Leave out inactive codes","schema":{"type":"boolean"}},{"name":"excludeNested","in":"query","description":"Return a flat list, not a hierarchy","schema":{"type":"boolean"}},{"name":"excludeNotForUI","in":"query","description":"Leave out codes that aren't for choosing in a user interface (abstract codes)","schema":{"type":"boolean"}},{"name":"excludePostCoordinated","in":"query","description":"Leave out post-coordinated codes","schema":{"type":"boolean"}},{"name":"includeDesignations","in":"query","description":"Include the designations of each code","schema":{"type":"boolean"}},{"name":"designation","in":"query","description":"A designation to include: `language`, or a `system|code` use","schema":{"type":"array","items":{"type":"string","x-fhir-type":"string"}},"style":"form","explode":true},{"name":"includeDefinition","in":"query","description":"Include the definition of each code","schema":{"type":"boolean"}},{"name":"property","in":"query","description":"A property to include for each code","schema":{"type":"array","items":{"type":"string","x-fhir-type":"string"}},"style":"form","explode":true},{"name":"sort","in":"query","description":"`code`, `display`, `design` or `prop:{name}`; prefix with - to reverse. Ignored for hierarchical expansions","schema":{"type":"string","x-fhir-type":"string"}},{"name":"versionsMatch","in":"query","description":"Treat a code as the same code in different versions of its code system","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The value set, with its expansion","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ValueSet"}},"application/json":{"schema":{"$ref":"#/components/schemas/ValueSet"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["ValueSet"],"operationId":"expandValueSetPost","summary":"Expand a value set","description":"Returns the codes in a value set, as ValueSet.expansion. The value set is named by url (and valueSetVersion), or sent as valueSet; at the instance level it's the value set with that id.\n\nA POST can also send the ValueSet itself as the body, with any other parameters in the query.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The value set to expand (type level) |\n| `valueSetVersion` | `string` | 0..1 | Its version |\n| `valueSet` | ValueSet | 0..1 | The value set to expand, sent with the request (POST, in a Parameters resource, only) |\n| `filter` | `string` | 0..1 | Text to filter the codes by (matching display and designations; how is up to the code system) |\n| `count` | `integer` | 0..1 | Paging: the number of codes to return |\n| `offset` | `integer` | 0..1 | Paging: where to start (0 based) |\n| `limit` | `integer` | 0..1 | Upper bound on the size of the expansion; the operation fails as too-costly beyond it |\n| `activeOnly` | `boolean` | 0..1 | Leave out inactive codes |\n| `excludeNested` | `boolean` | 0..1 | Return a flat list, not a hierarchy |\n| `excludeNotForUI` | `boolean` | 0..1 | Leave out codes that aren't for choosing in a user interface (abstract codes) |\n| `excludePostCoordinated` | `boolean` | 0..1 | Leave out post-coordinated codes |\n| `includeDesignations` | `boolean` | 0..1 | Include the designations of each code |\n| `designation` | `string` | 0..* | A designation to include: `language`, or a `system\\|code` use |\n| `includeDefinition` | `boolean` | 0..1 | Include the definition of each code |\n| `property` | `string` | 0..* | A property to include for each code |\n| `sort` | `string` | 0..1 | `code`, `display`, `design` or `prop:{name}`; prefix with - to reverse. Ignored for hierarchical expansions |\n| `versionsMatch` | `boolean` | 0..1 | Treat a code as the same code in different versions of its code system |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form), or the ValueSet itself","content":{"application/fhir+json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Parameters"},{"$ref":"#/components/schemas/ValueSet"}]}},"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Parameters"},{"$ref":"#/components/schemas/ValueSet"}]}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"url":{"type":"string","x-fhir-type":"uri"},"valueSetVersion":{"type":"string","x-fhir-type":"string"},"filter":{"type":"string","x-fhir-type":"string"},"count":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"activeOnly":{"type":"boolean"},"excludeNested":{"type":"boolean"},"excludeNotForUI":{"type":"boolean"},"excludePostCoordinated":{"type":"boolean"},"includeDesignations":{"type":"boolean"},"designation":{"type":"array","items":{"type":"string","x-fhir-type":"string"}},"includeDefinition":{"type":"boolean"},"property":{"type":"array","items":{"type":"string","x-fhir-type":"string"}},"sort":{"type":"string","x-fhir-type":"string"},"versionsMatch":{"type":"boolean"},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The value set, with its expansion","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ValueSet"}},"application/json":{"schema":{"$ref":"#/components/schemas/ValueSet"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/ValueSet/{id}/$expand":{"get":{"tags":["ValueSet"],"operationId":"expandValueSetInstance","summary":"Expand a value set","description":"Returns the codes in a value set, as ValueSet.expansion. The value set is named by url (and valueSetVersion), or sent as valueSet; at the instance level it's the value set with that id.\n\nA POST can also send the ValueSet itself as the body, with any other parameters in the query.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The value set to expand (type level) |\n| `valueSetVersion` | `string` | 0..1 | Its version |\n| `valueSet` | ValueSet | 0..1 | The value set to expand, sent with the request (POST, in a Parameters resource, only) |\n| `filter` | `string` | 0..1 | Text to filter the codes by (matching display and designations; how is up to the code system) |\n| `count` | `integer` | 0..1 | Paging: the number of codes to return |\n| `offset` | `integer` | 0..1 | Paging: where to start (0 based) |\n| `limit` | `integer` | 0..1 | Upper bound on the size of the expansion; the operation fails as too-costly beyond it |\n| `activeOnly` | `boolean` | 0..1 | Leave out inactive codes |\n| `excludeNested` | `boolean` | 0..1 | Return a flat list, not a hierarchy |\n| `excludeNotForUI` | `boolean` | 0..1 | Leave out codes that aren't for choosing in a user interface (abstract codes) |\n| `excludePostCoordinated` | `boolean` | 0..1 | Leave out post-coordinated codes |\n| `includeDesignations` | `boolean` | 0..1 | Include the designations of each code |\n| `designation` | `string` | 0..* | A designation to include: `language`, or a `system\\|code` use |\n| `includeDefinition` | `boolean` | 0..1 | Include the definition of each code |\n| `property` | `string` | 0..* | A property to include for each code |\n| `sort` | `string` | 0..1 | `code`, `display`, `design` or `prop:{name}`; prefix with - to reverse. Ignored for hierarchical expansions |\n| `versionsMatch` | `boolean` | 0..1 | Treat a code as the same code in different versions of its code system |\n\nThe ValueSet is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"url","in":"query","description":"The value set to expand (type level)","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"valueSetVersion","in":"query","description":"Its version","schema":{"type":"string","x-fhir-type":"string"}},{"name":"filter","in":"query","description":"Text to filter the codes by (matching display and designations; how is up to the code system)","schema":{"type":"string","x-fhir-type":"string"}},{"name":"count","in":"query","description":"Paging: the number of codes to return","schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Paging: where to start (0 based)","schema":{"type":"integer"}},{"name":"limit","in":"query","description":"Upper bound on the size of the expansion; the operation fails as too-costly beyond it","schema":{"type":"integer"}},{"name":"activeOnly","in":"query","description":"Leave out inactive codes","schema":{"type":"boolean"}},{"name":"excludeNested","in":"query","description":"Return a flat list, not a hierarchy","schema":{"type":"boolean"}},{"name":"excludeNotForUI","in":"query","description":"Leave out codes that aren't for choosing in a user interface (abstract codes)","schema":{"type":"boolean"}},{"name":"excludePostCoordinated","in":"query","description":"Leave out post-coordinated codes","schema":{"type":"boolean"}},{"name":"includeDesignations","in":"query","description":"Include the designations of each code","schema":{"type":"boolean"}},{"name":"designation","in":"query","description":"A designation to include: `language`, or a `system|code` use","schema":{"type":"array","items":{"type":"string","x-fhir-type":"string"}},"style":"form","explode":true},{"name":"includeDefinition","in":"query","description":"Include the definition of each code","schema":{"type":"boolean"}},{"name":"property","in":"query","description":"A property to include for each code","schema":{"type":"array","items":{"type":"string","x-fhir-type":"string"}},"style":"form","explode":true},{"name":"sort","in":"query","description":"`code`, `display`, `design` or `prop:{name}`; prefix with - to reverse. Ignored for hierarchical expansions","schema":{"type":"string","x-fhir-type":"string"}},{"name":"versionsMatch","in":"query","description":"Treat a code as the same code in different versions of its code system","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The value set, with its expansion","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ValueSet"}},"application/json":{"schema":{"$ref":"#/components/schemas/ValueSet"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["ValueSet"],"operationId":"expandValueSetInstancePost","summary":"Expand a value set","description":"Returns the codes in a value set, as ValueSet.expansion. The value set is named by url (and valueSetVersion), or sent as valueSet; at the instance level it's the value set with that id.\n\nA POST can also send the ValueSet itself as the body, with any other parameters in the query.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The value set to expand (type level) |\n| `valueSetVersion` | `string` | 0..1 | Its version |\n| `valueSet` | ValueSet | 0..1 | The value set to expand, sent with the request (POST, in a Parameters resource, only) |\n| `filter` | `string` | 0..1 | Text to filter the codes by (matching display and designations; how is up to the code system) |\n| `count` | `integer` | 0..1 | Paging: the number of codes to return |\n| `offset` | `integer` | 0..1 | Paging: where to start (0 based) |\n| `limit` | `integer` | 0..1 | Upper bound on the size of the expansion; the operation fails as too-costly beyond it |\n| `activeOnly` | `boolean` | 0..1 | Leave out inactive codes |\n| `excludeNested` | `boolean` | 0..1 | Return a flat list, not a hierarchy |\n| `excludeNotForUI` | `boolean` | 0..1 | Leave out codes that aren't for choosing in a user interface (abstract codes) |\n| `excludePostCoordinated` | `boolean` | 0..1 | Leave out post-coordinated codes |\n| `includeDesignations` | `boolean` | 0..1 | Include the designations of each code |\n| `designation` | `string` | 0..* | A designation to include: `language`, or a `system\\|code` use |\n| `includeDefinition` | `boolean` | 0..1 | Include the definition of each code |\n| `property` | `string` | 0..* | A property to include for each code |\n| `sort` | `string` | 0..1 | `code`, `display`, `design` or `prop:{name}`; prefix with - to reverse. Ignored for hierarchical expansions |\n| `versionsMatch` | `boolean` | 0..1 | Treat a code as the same code in different versions of its code system |\n\nThe ValueSet is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form), or the ValueSet itself","content":{"application/fhir+json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Parameters"},{"$ref":"#/components/schemas/ValueSet"}]}},"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Parameters"},{"$ref":"#/components/schemas/ValueSet"}]}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"url":{"type":"string","x-fhir-type":"uri"},"valueSetVersion":{"type":"string","x-fhir-type":"string"},"filter":{"type":"string","x-fhir-type":"string"},"count":{"type":"integer"},"offset":{"type":"integer"},"limit":{"type":"integer"},"activeOnly":{"type":"boolean"},"excludeNested":{"type":"boolean"},"excludeNotForUI":{"type":"boolean"},"excludePostCoordinated":{"type":"boolean"},"includeDesignations":{"type":"boolean"},"designation":{"type":"array","items":{"type":"string","x-fhir-type":"string"}},"includeDefinition":{"type":"boolean"},"property":{"type":"array","items":{"type":"string","x-fhir-type":"string"}},"sort":{"type":"string","x-fhir-type":"string"},"versionsMatch":{"type":"boolean"},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The value set, with its expansion","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ValueSet"}},"application/json":{"schema":{"$ref":"#/components/schemas/ValueSet"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/ValueSet/$validate-code":{"get":{"tags":["ValueSet"],"operationId":"validateCodeValueSet","summary":"Is a code in a value set?","description":"Validates a code, Coding or CodeableConcept against a value set: whether it's in the value set, and whether it's valid in its code system (display, status, and so on).\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The value set (type level) |\n| `valueSetVersion` | `string` | 0..1 | Its version |\n| `valueSet` | ValueSet | 0..1 | The value set, sent with the request (POST, in a Parameters resource, only) |\n| `code` | `code` | 0..1 | The code to validate (with system) |\n| `system` | `uri` | 0..1 | Its code system |\n| `systemVersion` | `string` | 0..1 | The version of the code system |\n| `display` | `string` | 0..1 | Its display, to check |\n| `inferSystem` | `boolean` | 0..1 | Work out the system from the value set, if code has no system |\n| `coding` | Coding | 0..1 | The Coding to validate (POST, in a Parameters resource, only) |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept to validate: valid if any of its codings is (POST, in a Parameters resource, only) |\n| `abstract` | `boolean` | 0..1 | Whether abstract codes are valid (default true) |\n| `activeOnly` | `boolean` | 0..1 | Inactive codes are not valid |\n| `lenient-display-validation` | `boolean` | 0..1 | A wrong display is a warning rather than an error |\n| `valueset-membership-only` | `boolean` | 0..1 | Only check that the code is in the value set: not the display, status, and so on |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `boolean` | 1..1 | Whether the code is valid |\n| `message` | `string` | 0..1 | The errors and warnings, as text |\n| `display` | `string` | 0..1 | The display of the code |\n| `code` | `code` | 0..1 | The code that was validated |\n| `system` | `uri` | 0..1 | Its code system |\n| `version` | `string` | 0..1 | The version of the code system |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept that was validated |\n| `inactive` | `boolean` | 0..1 | The code is inactive |\n| `status` | `code` | 0..1 | The status of the code, when it's not active |\n| `normalized-code` | `code` | 0..1 | The code as the code system has it, when it was validated case-insensitively |\n| `issues` | OperationOutcome | 0..1 | The issues, with their locations and tx-issue-type codes |\n| `x-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have |\n| `x-caused-by-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have, which made the validation impossible |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"url","in":"query","description":"The value set (type level)","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"valueSetVersion","in":"query","description":"Its version","schema":{"type":"string","x-fhir-type":"string"}},{"name":"code","in":"query","description":"The code to validate (with system)","schema":{"type":"string","x-fhir-type":"code"}},{"name":"system","in":"query","description":"Its code system","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"systemVersion","in":"query","description":"The version of the code system","schema":{"type":"string","x-fhir-type":"string"}},{"name":"display","in":"query","description":"Its display, to check","schema":{"type":"string","x-fhir-type":"string"}},{"name":"inferSystem","in":"query","description":"Work out the system from the value set, if code has no system","schema":{"type":"boolean"}},{"name":"abstract","in":"query","description":"Whether abstract codes are valid (default true)","schema":{"type":"boolean"}},{"name":"activeOnly","in":"query","description":"Inactive codes are not valid","schema":{"type":"boolean"}},{"name":"lenient-display-validation","in":"query","description":"A wrong display is a warning rather than an error","schema":{"type":"boolean"}},{"name":"valueset-membership-only","in":"query","description":"Only check that the code is in the value set: not the display, status, and so on","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["ValueSet"],"operationId":"validateCodeValueSetPost","summary":"Is a code in a value set?","description":"Validates a code, Coding or CodeableConcept against a value set: whether it's in the value set, and whether it's valid in its code system (display, status, and so on).\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The value set (type level) |\n| `valueSetVersion` | `string` | 0..1 | Its version |\n| `valueSet` | ValueSet | 0..1 | The value set, sent with the request (POST, in a Parameters resource, only) |\n| `code` | `code` | 0..1 | The code to validate (with system) |\n| `system` | `uri` | 0..1 | Its code system |\n| `systemVersion` | `string` | 0..1 | The version of the code system |\n| `display` | `string` | 0..1 | Its display, to check |\n| `inferSystem` | `boolean` | 0..1 | Work out the system from the value set, if code has no system |\n| `coding` | Coding | 0..1 | The Coding to validate (POST, in a Parameters resource, only) |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept to validate: valid if any of its codings is (POST, in a Parameters resource, only) |\n| `abstract` | `boolean` | 0..1 | Whether abstract codes are valid (default true) |\n| `activeOnly` | `boolean` | 0..1 | Inactive codes are not valid |\n| `lenient-display-validation` | `boolean` | 0..1 | A wrong display is a warning rather than an error |\n| `valueset-membership-only` | `boolean` | 0..1 | Only check that the code is in the value set: not the display, status, and so on |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `boolean` | 1..1 | Whether the code is valid |\n| `message` | `string` | 0..1 | The errors and warnings, as text |\n| `display` | `string` | 0..1 | The display of the code |\n| `code` | `code` | 0..1 | The code that was validated |\n| `system` | `uri` | 0..1 | Its code system |\n| `version` | `string` | 0..1 | The version of the code system |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept that was validated |\n| `inactive` | `boolean` | 0..1 | The code is inactive |\n| `status` | `code` | 0..1 | The status of the code, when it's not active |\n| `normalized-code` | `code` | 0..1 | The code as the code system has it, when it was validated case-insensitively |\n| `issues` | OperationOutcome | 0..1 | The issues, with their locations and tx-issue-type codes |\n| `x-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have |\n| `x-caused-by-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have, which made the validation impossible |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"url":{"type":"string","x-fhir-type":"uri"},"valueSetVersion":{"type":"string","x-fhir-type":"string"},"code":{"type":"string","x-fhir-type":"code"},"system":{"type":"string","x-fhir-type":"uri"},"systemVersion":{"type":"string","x-fhir-type":"string"},"display":{"type":"string","x-fhir-type":"string"},"inferSystem":{"type":"boolean"},"abstract":{"type":"boolean"},"activeOnly":{"type":"boolean"},"lenient-display-validation":{"type":"boolean"},"valueset-membership-only":{"type":"boolean"},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/ValueSet/{id}/$validate-code":{"get":{"tags":["ValueSet"],"operationId":"validateCodeValueSetInstance","summary":"Is a code in a value set?","description":"Validates a code, Coding or CodeableConcept against a value set: whether it's in the value set, and whether it's valid in its code system (display, status, and so on).\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The value set (type level) |\n| `valueSetVersion` | `string` | 0..1 | Its version |\n| `valueSet` | ValueSet | 0..1 | The value set, sent with the request (POST, in a Parameters resource, only) |\n| `code` | `code` | 0..1 | The code to validate (with system) |\n| `system` | `uri` | 0..1 | Its code system |\n| `systemVersion` | `string` | 0..1 | The version of the code system |\n| `display` | `string` | 0..1 | Its display, to check |\n| `inferSystem` | `boolean` | 0..1 | Work out the system from the value set, if code has no system |\n| `coding` | Coding | 0..1 | The Coding to validate (POST, in a Parameters resource, only) |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept to validate: valid if any of its codings is (POST, in a Parameters resource, only) |\n| `abstract` | `boolean` | 0..1 | Whether abstract codes are valid (default true) |\n| `activeOnly` | `boolean` | 0..1 | Inactive codes are not valid |\n| `lenient-display-validation` | `boolean` | 0..1 | A wrong display is a warning rather than an error |\n| `valueset-membership-only` | `boolean` | 0..1 | Only check that the code is in the value set: not the display, status, and so on |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `boolean` | 1..1 | Whether the code is valid |\n| `message` | `string` | 0..1 | The errors and warnings, as text |\n| `display` | `string` | 0..1 | The display of the code |\n| `code` | `code` | 0..1 | The code that was validated |\n| `system` | `uri` | 0..1 | Its code system |\n| `version` | `string` | 0..1 | The version of the code system |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept that was validated |\n| `inactive` | `boolean` | 0..1 | The code is inactive |\n| `status` | `code` | 0..1 | The status of the code, when it's not active |\n| `normalized-code` | `code` | 0..1 | The code as the code system has it, when it was validated case-insensitively |\n| `issues` | OperationOutcome | 0..1 | The issues, with their locations and tx-issue-type codes |\n| `x-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have |\n| `x-caused-by-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have, which made the validation impossible |\n\nThe ValueSet is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"url","in":"query","description":"The value set (type level)","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"valueSetVersion","in":"query","description":"Its version","schema":{"type":"string","x-fhir-type":"string"}},{"name":"code","in":"query","description":"The code to validate (with system)","schema":{"type":"string","x-fhir-type":"code"}},{"name":"system","in":"query","description":"Its code system","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"systemVersion","in":"query","description":"The version of the code system","schema":{"type":"string","x-fhir-type":"string"}},{"name":"display","in":"query","description":"Its display, to check","schema":{"type":"string","x-fhir-type":"string"}},{"name":"inferSystem","in":"query","description":"Work out the system from the value set, if code has no system","schema":{"type":"boolean"}},{"name":"abstract","in":"query","description":"Whether abstract codes are valid (default true)","schema":{"type":"boolean"}},{"name":"activeOnly","in":"query","description":"Inactive codes are not valid","schema":{"type":"boolean"}},{"name":"lenient-display-validation","in":"query","description":"A wrong display is a warning rather than an error","schema":{"type":"boolean"}},{"name":"valueset-membership-only","in":"query","description":"Only check that the code is in the value set: not the display, status, and so on","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["ValueSet"],"operationId":"validateCodeValueSetInstancePost","summary":"Is a code in a value set?","description":"Validates a code, Coding or CodeableConcept against a value set: whether it's in the value set, and whether it's valid in its code system (display, status, and so on).\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The value set (type level) |\n| `valueSetVersion` | `string` | 0..1 | Its version |\n| `valueSet` | ValueSet | 0..1 | The value set, sent with the request (POST, in a Parameters resource, only) |\n| `code` | `code` | 0..1 | The code to validate (with system) |\n| `system` | `uri` | 0..1 | Its code system |\n| `systemVersion` | `string` | 0..1 | The version of the code system |\n| `display` | `string` | 0..1 | Its display, to check |\n| `inferSystem` | `boolean` | 0..1 | Work out the system from the value set, if code has no system |\n| `coding` | Coding | 0..1 | The Coding to validate (POST, in a Parameters resource, only) |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept to validate: valid if any of its codings is (POST, in a Parameters resource, only) |\n| `abstract` | `boolean` | 0..1 | Whether abstract codes are valid (default true) |\n| `activeOnly` | `boolean` | 0..1 | Inactive codes are not valid |\n| `lenient-display-validation` | `boolean` | 0..1 | A wrong display is a warning rather than an error |\n| `valueset-membership-only` | `boolean` | 0..1 | Only check that the code is in the value set: not the display, status, and so on |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `boolean` | 1..1 | Whether the code is valid |\n| `message` | `string` | 0..1 | The errors and warnings, as text |\n| `display` | `string` | 0..1 | The display of the code |\n| `code` | `code` | 0..1 | The code that was validated |\n| `system` | `uri` | 0..1 | Its code system |\n| `version` | `string` | 0..1 | The version of the code system |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept that was validated |\n| `inactive` | `boolean` | 0..1 | The code is inactive |\n| `status` | `code` | 0..1 | The status of the code, when it's not active |\n| `normalized-code` | `code` | 0..1 | The code as the code system has it, when it was validated case-insensitively |\n| `issues` | OperationOutcome | 0..1 | The issues, with their locations and tx-issue-type codes |\n| `x-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have |\n| `x-caused-by-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have, which made the validation impossible |\n\nThe ValueSet is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"url":{"type":"string","x-fhir-type":"uri"},"valueSetVersion":{"type":"string","x-fhir-type":"string"},"code":{"type":"string","x-fhir-type":"code"},"system":{"type":"string","x-fhir-type":"uri"},"systemVersion":{"type":"string","x-fhir-type":"string"},"display":{"type":"string","x-fhir-type":"string"},"inferSystem":{"type":"boolean"},"abstract":{"type":"boolean"},"activeOnly":{"type":"boolean"},"lenient-display-validation":{"type":"boolean"},"valueset-membership-only":{"type":"boolean"},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/CodeSystem/$validate-code":{"get":{"tags":["CodeSystem"],"operationId":"validateCodeCodeSystem","summary":"Is a code valid in a code system?","description":"Validates a code, Coding or CodeableConcept against a code system.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The code system (type level; system is accepted too) |\n| `version` | `string` | 0..1 | Its version |\n| `codeSystem` | CodeSystem | 0..1 | The code system, sent with the request (POST, in a Parameters resource, only) |\n| `code` | `code` | 0..1 | The code to validate |\n| `system` | `uri` | 0..1 | The code system, if url isn't given |\n| `display` | `string` | 0..1 | Its display, to check |\n| `coding` | Coding | 0..1 | The Coding to validate (POST, in a Parameters resource, only) |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept to validate (POST, in a Parameters resource, only) |\n| `abstract` | `boolean` | 0..1 | Whether abstract codes are valid (default true) |\n| `activeOnly` | `boolean` | 0..1 | Inactive codes are not valid |\n| `lenient-display-validation` | `boolean` | 0..1 | A wrong display is a warning rather than an error |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `boolean` | 1..1 | Whether the code is valid |\n| `message` | `string` | 0..1 | The errors and warnings, as text |\n| `display` | `string` | 0..1 | The display of the code |\n| `code` | `code` | 0..1 | The code that was validated |\n| `system` | `uri` | 0..1 | Its code system |\n| `version` | `string` | 0..1 | The version of the code system |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept that was validated |\n| `inactive` | `boolean` | 0..1 | The code is inactive |\n| `status` | `code` | 0..1 | The status of the code, when it's not active |\n| `normalized-code` | `code` | 0..1 | The code as the code system has it, when it was validated case-insensitively |\n| `issues` | OperationOutcome | 0..1 | The issues, with their locations and tx-issue-type codes |\n| `x-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have |\n| `x-caused-by-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have, which made the validation impossible |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"url","in":"query","description":"The code system (type level; system is accepted too)","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"version","in":"query","description":"Its version","schema":{"type":"string","x-fhir-type":"string"}},{"name":"code","in":"query","description":"The code to validate","schema":{"type":"string","x-fhir-type":"code"}},{"name":"system","in":"query","description":"The code system, if url isn't given","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"display","in":"query","description":"Its display, to check","schema":{"type":"string","x-fhir-type":"string"}},{"name":"abstract","in":"query","description":"Whether abstract codes are valid (default true)","schema":{"type":"boolean"}},{"name":"activeOnly","in":"query","description":"Inactive codes are not valid","schema":{"type":"boolean"}},{"name":"lenient-display-validation","in":"query","description":"A wrong display is a warning rather than an error","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["CodeSystem"],"operationId":"validateCodeCodeSystemPost","summary":"Is a code valid in a code system?","description":"Validates a code, Coding or CodeableConcept against a code system.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The code system (type level; system is accepted too) |\n| `version` | `string` | 0..1 | Its version |\n| `codeSystem` | CodeSystem | 0..1 | The code system, sent with the request (POST, in a Parameters resource, only) |\n| `code` | `code` | 0..1 | The code to validate |\n| `system` | `uri` | 0..1 | The code system, if url isn't given |\n| `display` | `string` | 0..1 | Its display, to check |\n| `coding` | Coding | 0..1 | The Coding to validate (POST, in a Parameters resource, only) |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept to validate (POST, in a Parameters resource, only) |\n| `abstract` | `boolean` | 0..1 | Whether abstract codes are valid (default true) |\n| `activeOnly` | `boolean` | 0..1 | Inactive codes are not valid |\n| `lenient-display-validation` | `boolean` | 0..1 | A wrong display is a warning rather than an error |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `boolean` | 1..1 | Whether the code is valid |\n| `message` | `string` | 0..1 | The errors and warnings, as text |\n| `display` | `string` | 0..1 | The display of the code |\n| `code` | `code` | 0..1 | The code that was validated |\n| `system` | `uri` | 0..1 | Its code system |\n| `version` | `string` | 0..1 | The version of the code system |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept that was validated |\n| `inactive` | `boolean` | 0..1 | The code is inactive |\n| `status` | `code` | 0..1 | The status of the code, when it's not active |\n| `normalized-code` | `code` | 0..1 | The code as the code system has it, when it was validated case-insensitively |\n| `issues` | OperationOutcome | 0..1 | The issues, with their locations and tx-issue-type codes |\n| `x-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have |\n| `x-caused-by-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have, which made the validation impossible |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"url":{"type":"string","x-fhir-type":"uri"},"version":{"type":"string","x-fhir-type":"string"},"code":{"type":"string","x-fhir-type":"code"},"system":{"type":"string","x-fhir-type":"uri"},"display":{"type":"string","x-fhir-type":"string"},"abstract":{"type":"boolean"},"activeOnly":{"type":"boolean"},"lenient-display-validation":{"type":"boolean"},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/CodeSystem/{id}/$validate-code":{"get":{"tags":["CodeSystem"],"operationId":"validateCodeCodeSystemInstance","summary":"Is a code valid in a code system?","description":"Validates a code, Coding or CodeableConcept against a code system.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The code system (type level; system is accepted too) |\n| `version` | `string` | 0..1 | Its version |\n| `codeSystem` | CodeSystem | 0..1 | The code system, sent with the request (POST, in a Parameters resource, only) |\n| `code` | `code` | 0..1 | The code to validate |\n| `system` | `uri` | 0..1 | The code system, if url isn't given |\n| `display` | `string` | 0..1 | Its display, to check |\n| `coding` | Coding | 0..1 | The Coding to validate (POST, in a Parameters resource, only) |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept to validate (POST, in a Parameters resource, only) |\n| `abstract` | `boolean` | 0..1 | Whether abstract codes are valid (default true) |\n| `activeOnly` | `boolean` | 0..1 | Inactive codes are not valid |\n| `lenient-display-validation` | `boolean` | 0..1 | A wrong display is a warning rather than an error |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `boolean` | 1..1 | Whether the code is valid |\n| `message` | `string` | 0..1 | The errors and warnings, as text |\n| `display` | `string` | 0..1 | The display of the code |\n| `code` | `code` | 0..1 | The code that was validated |\n| `system` | `uri` | 0..1 | Its code system |\n| `version` | `string` | 0..1 | The version of the code system |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept that was validated |\n| `inactive` | `boolean` | 0..1 | The code is inactive |\n| `status` | `code` | 0..1 | The status of the code, when it's not active |\n| `normalized-code` | `code` | 0..1 | The code as the code system has it, when it was validated case-insensitively |\n| `issues` | OperationOutcome | 0..1 | The issues, with their locations and tx-issue-type codes |\n| `x-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have |\n| `x-caused-by-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have, which made the validation impossible |\n\nThe CodeSystem is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"url","in":"query","description":"The code system (type level; system is accepted too)","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"version","in":"query","description":"Its version","schema":{"type":"string","x-fhir-type":"string"}},{"name":"code","in":"query","description":"The code to validate","schema":{"type":"string","x-fhir-type":"code"}},{"name":"system","in":"query","description":"The code system, if url isn't given","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"display","in":"query","description":"Its display, to check","schema":{"type":"string","x-fhir-type":"string"}},{"name":"abstract","in":"query","description":"Whether abstract codes are valid (default true)","schema":{"type":"boolean"}},{"name":"activeOnly","in":"query","description":"Inactive codes are not valid","schema":{"type":"boolean"}},{"name":"lenient-display-validation","in":"query","description":"A wrong display is a warning rather than an error","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["CodeSystem"],"operationId":"validateCodeCodeSystemInstancePost","summary":"Is a code valid in a code system?","description":"Validates a code, Coding or CodeableConcept against a code system.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The code system (type level; system is accepted too) |\n| `version` | `string` | 0..1 | Its version |\n| `codeSystem` | CodeSystem | 0..1 | The code system, sent with the request (POST, in a Parameters resource, only) |\n| `code` | `code` | 0..1 | The code to validate |\n| `system` | `uri` | 0..1 | The code system, if url isn't given |\n| `display` | `string` | 0..1 | Its display, to check |\n| `coding` | Coding | 0..1 | The Coding to validate (POST, in a Parameters resource, only) |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept to validate (POST, in a Parameters resource, only) |\n| `abstract` | `boolean` | 0..1 | Whether abstract codes are valid (default true) |\n| `activeOnly` | `boolean` | 0..1 | Inactive codes are not valid |\n| `lenient-display-validation` | `boolean` | 0..1 | A wrong display is a warning rather than an error |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `boolean` | 1..1 | Whether the code is valid |\n| `message` | `string` | 0..1 | The errors and warnings, as text |\n| `display` | `string` | 0..1 | The display of the code |\n| `code` | `code` | 0..1 | The code that was validated |\n| `system` | `uri` | 0..1 | Its code system |\n| `version` | `string` | 0..1 | The version of the code system |\n| `codeableConcept` | CodeableConcept | 0..1 | The CodeableConcept that was validated |\n| `inactive` | `boolean` | 0..1 | The code is inactive |\n| `status` | `code` | 0..1 | The status of the code, when it's not active |\n| `normalized-code` | `code` | 0..1 | The code as the code system has it, when it was validated case-insensitively |\n| `issues` | OperationOutcome | 0..1 | The issues, with their locations and tx-issue-type codes |\n| `x-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have |\n| `x-caused-by-unknown-system` | `canonical` | 0..* | A code system (or version) the server doesn't have, which made the validation impossible |\n\nThe CodeSystem is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"url":{"type":"string","x-fhir-type":"uri"},"version":{"type":"string","x-fhir-type":"string"},"code":{"type":"string","x-fhir-type":"code"},"system":{"type":"string","x-fhir-type":"uri"},"display":{"type":"string","x-fhir-type":"string"},"abstract":{"type":"boolean"},"activeOnly":{"type":"boolean"},"lenient-display-validation":{"type":"boolean"},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/ValueSet/$batch-validate-code":{"post":{"tags":["ValueSet"],"operationId":"batchValidateCodeValueSet","summary":"Validate many codes against value sets","description":"A batch of $validate-code requests: each `validation` is a Parameters resource with the parameters of one ValueSet $validate-code. url, valueSet, tx-resource and lenient-display-validation at the top level apply to every validation that doesn't have its own. Each result is a `validation` in the response, in the same order: the Parameters $validate-code returns, or an OperationOutcome.\n\n**In parameters**\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `validation` | Parameters | 1..* | The parameters of one $validate-code (POST, in a Parameters resource, only) |\n| `url` | `uri` | 0..1 | The value set, for every validation |\n| `valueSet` | ValueSet | 0..1 | The value set, for every validation (POST, in a Parameters resource, only) |\n| `lenient-display-validation` | `boolean` | 0..1 | For every validation |\n| `tx-resource` | Resource | 0..* | Resources for every validation (POST, in a Parameters resource, only) |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `validation` | Parameters | 0..* | The result of each validation (or an OperationOutcome) |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"url":{"type":"string","x-fhir-type":"uri"},"lenient-display-validation":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/CodeSystem/$batch-validate-code":{"post":{"tags":["CodeSystem"],"operationId":"batchValidateCodeCodeSystem","summary":"Validate many codes against code systems","description":"A batch of CodeSystem $validate-code requests: each `validation` is a Parameters resource with the parameters of one. system, codeSystem, tx-resource and lenient-display-validation at the top level apply to every validation that doesn't have its own.\n\n**In parameters**\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `validation` | Parameters | 1..* | The parameters of one $validate-code (POST, in a Parameters resource, only) |\n| `system` | `uri` | 0..1 | The code system, for every validation |\n| `codeSystem` | CodeSystem | 0..1 | The code system, for every validation (POST, in a Parameters resource, only) |\n| `lenient-display-validation` | `boolean` | 0..1 | For every validation |\n| `tx-resource` | Resource | 0..* | Resources for every validation (POST, in a Parameters resource, only) |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `validation` | Parameters | 0..* | The result of each validation (or an OperationOutcome) |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"system":{"type":"string","x-fhir-type":"uri"},"lenient-display-validation":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/CodeSystem/$lookup":{"get":{"tags":["CodeSystem"],"operationId":"lookupCodeSystem","summary":"Look up a code","description":"Returns the details of a code: its display, definition, designations and properties.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `code` | `code` | 0..1 | The code (with system) |\n| `system` | `uri` | 0..1 | Its code system (type level) |\n| `version` | `string` | 0..1 | The version of the code system |\n| `coding` | Coding | 0..1 | The code, as a Coding (POST, in a Parameters resource, only) |\n| `property` | `code` | 0..* | A property to return (by default, all of them) |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `name` | `string` | 1..1 | The name of the code system |\n| `system` | `uri` | 0..1 | The code system |\n| `version` | `string` | 0..1 | Its version |\n| `code` | `code` | 0..1 | The code |\n| `display` | `string` | 1..1 | Its display |\n| `definition` | `string` | 0..1 | Its definition |\n| `abstract` | `boolean` | 0..1 | Whether it's abstract (not for use) |\n| `designation` | parts | 0..* | A designation |\n| &nbsp;&nbsp;`designation.language` | `code` | 0..1 |  |\n| &nbsp;&nbsp;`designation.use` | Coding | 0..1 |  |\n| &nbsp;&nbsp;`designation.value` | `string` | 0..1 |  |\n| &nbsp;&nbsp;`designation.source` | Coding | 0..1 | Where the designation comes from (e.g. a supplement) |\n| &nbsp;&nbsp;`designation.status` | `code` | 0..1 |  |\n| `property` | parts | 0..* | A property |\n| &nbsp;&nbsp;`property.code` | `code` | 0..1 |  |\n| &nbsp;&nbsp;`property.value` | any | 0..1 |  |\n| &nbsp;&nbsp;`property.description` | `string` | 0..1 |  |\n| `used-supplement` | `canonical` | 0..* | A supplement that was used |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"code","in":"query","description":"The code (with system)","schema":{"type":"string","x-fhir-type":"code"}},{"name":"system","in":"query","description":"Its code system (type level)","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"version","in":"query","description":"The version of the code system","schema":{"type":"string","x-fhir-type":"string"}},{"name":"property","in":"query","description":"A property to return (by default, all of them)","schema":{"type":"array","items":{"type":"string","x-fhir-type":"code"}},"style":"form","explode":true},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["CodeSystem"],"operationId":"lookupCodeSystemPost","summary":"Look up a code","description":"Returns the details of a code: its display, definition, designations and properties.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `code` | `code` | 0..1 | The code (with system) |\n| `system` | `uri` | 0..1 | Its code system (type level) |\n| `version` | `string` | 0..1 | The version of the code system |\n| `coding` | Coding | 0..1 | The code, as a Coding (POST, in a Parameters resource, only) |\n| `property` | `code` | 0..* | A property to return (by default, all of them) |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `name` | `string` | 1..1 | The name of the code system |\n| `system` | `uri` | 0..1 | The code system |\n| `version` | `string` | 0..1 | Its version |\n| `code` | `code` | 0..1 | The code |\n| `display` | `string` | 1..1 | Its display |\n| `definition` | `string` | 0..1 | Its definition |\n| `abstract` | `boolean` | 0..1 | Whether it's abstract (not for use) |\n| `designation` | parts | 0..* | A designation |\n| &nbsp;&nbsp;`designation.language` | `code` | 0..1 |  |\n| &nbsp;&nbsp;`designation.use` | Coding | 0..1 |  |\n| &nbsp;&nbsp;`designation.value` | `string` | 0..1 |  |\n| &nbsp;&nbsp;`designation.source` | Coding | 0..1 | Where the designation comes from (e.g. a supplement) |\n| &nbsp;&nbsp;`designation.status` | `code` | 0..1 |  |\n| `property` | parts | 0..* | A property |\n| &nbsp;&nbsp;`property.code` | `code` | 0..1 |  |\n| &nbsp;&nbsp;`property.value` | any | 0..1 |  |\n| &nbsp;&nbsp;`property.description` | `string` | 0..1 |  |\n| `used-supplement` | `canonical` | 0..* | A supplement that was used |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"code":{"type":"string","x-fhir-type":"code"},"system":{"type":"string","x-fhir-type":"uri"},"version":{"type":"string","x-fhir-type":"string"},"property":{"type":"array","items":{"type":"string","x-fhir-type":"code"}},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/CodeSystem/{id}/$lookup":{"get":{"tags":["CodeSystem"],"operationId":"lookupCodeSystemInstance","summary":"Look up a code","description":"Returns the details of a code: its display, definition, designations and properties.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `code` | `code` | 0..1 | The code (with system) |\n| `system` | `uri` | 0..1 | Its code system (type level) |\n| `version` | `string` | 0..1 | The version of the code system |\n| `coding` | Coding | 0..1 | The code, as a Coding (POST, in a Parameters resource, only) |\n| `property` | `code` | 0..* | A property to return (by default, all of them) |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `name` | `string` | 1..1 | The name of the code system |\n| `system` | `uri` | 0..1 | The code system |\n| `version` | `string` | 0..1 | Its version |\n| `code` | `code` | 0..1 | The code |\n| `display` | `string` | 1..1 | Its display |\n| `definition` | `string` | 0..1 | Its definition |\n| `abstract` | `boolean` | 0..1 | Whether it's abstract (not for use) |\n| `designation` | parts | 0..* | A designation |\n| &nbsp;&nbsp;`designation.language` | `code` | 0..1 |  |\n| &nbsp;&nbsp;`designation.use` | Coding | 0..1 |  |\n| &nbsp;&nbsp;`designation.value` | `string` | 0..1 |  |\n| &nbsp;&nbsp;`designation.source` | Coding | 0..1 | Where the designation comes from (e.g. a supplement) |\n| &nbsp;&nbsp;`designation.status` | `code` | 0..1 |  |\n| `property` | parts | 0..* | A property |\n| &nbsp;&nbsp;`property.code` | `code` | 0..1 |  |\n| &nbsp;&nbsp;`property.value` | any | 0..1 |  |\n| &nbsp;&nbsp;`property.description` | `string` | 0..1 |  |\n| `used-supplement` | `canonical` | 0..* | A supplement that was used |\n\nThe CodeSystem is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"code","in":"query","description":"The code (with system)","schema":{"type":"string","x-fhir-type":"code"}},{"name":"system","in":"query","description":"Its code system (type level)","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"version","in":"query","description":"The version of the code system","schema":{"type":"string","x-fhir-type":"string"}},{"name":"property","in":"query","description":"A property to return (by default, all of them)","schema":{"type":"array","items":{"type":"string","x-fhir-type":"code"}},"style":"form","explode":true},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["CodeSystem"],"operationId":"lookupCodeSystemInstancePost","summary":"Look up a code","description":"Returns the details of a code: its display, definition, designations and properties.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `code` | `code` | 0..1 | The code (with system) |\n| `system` | `uri` | 0..1 | Its code system (type level) |\n| `version` | `string` | 0..1 | The version of the code system |\n| `coding` | Coding | 0..1 | The code, as a Coding (POST, in a Parameters resource, only) |\n| `property` | `code` | 0..* | A property to return (by default, all of them) |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `name` | `string` | 1..1 | The name of the code system |\n| `system` | `uri` | 0..1 | The code system |\n| `version` | `string` | 0..1 | Its version |\n| `code` | `code` | 0..1 | The code |\n| `display` | `string` | 1..1 | Its display |\n| `definition` | `string` | 0..1 | Its definition |\n| `abstract` | `boolean` | 0..1 | Whether it's abstract (not for use) |\n| `designation` | parts | 0..* | A designation |\n| &nbsp;&nbsp;`designation.language` | `code` | 0..1 |  |\n| &nbsp;&nbsp;`designation.use` | Coding | 0..1 |  |\n| &nbsp;&nbsp;`designation.value` | `string` | 0..1 |  |\n| &nbsp;&nbsp;`designation.source` | Coding | 0..1 | Where the designation comes from (e.g. a supplement) |\n| &nbsp;&nbsp;`designation.status` | `code` | 0..1 |  |\n| `property` | parts | 0..* | A property |\n| &nbsp;&nbsp;`property.code` | `code` | 0..1 |  |\n| &nbsp;&nbsp;`property.value` | any | 0..1 |  |\n| &nbsp;&nbsp;`property.description` | `string` | 0..1 |  |\n| `used-supplement` | `canonical` | 0..* | A supplement that was used |\n\nThe CodeSystem is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"code":{"type":"string","x-fhir-type":"code"},"system":{"type":"string","x-fhir-type":"uri"},"version":{"type":"string","x-fhir-type":"string"},"property":{"type":"array","items":{"type":"string","x-fhir-type":"code"}},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/CodeSystem/$subsumes":{"get":{"tags":["CodeSystem"],"operationId":"subsumesCodeSystem","summary":"Does one code subsume another?","description":"Tests the relationship between two codes in a code system.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `codeA` | `code` | 0..1 | The first code |\n| `codeB` | `code` | 0..1 | The second code |\n| `system` | `uri` | 0..1 | Their code system (type level) |\n| `version` | `string` | 0..1 | Its version |\n| `codingA` | Coding | 0..1 | The first code, as a Coding (POST, in a Parameters resource, only) |\n| `codingB` | Coding | 0..1 | The second code, as a Coding (POST, in a Parameters resource, only) |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `outcome` | `code` | 1..1 | `equivalent`, `subsumes`, `subsumed-by` or `not-subsumed` |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"codeA","in":"query","description":"The first code","schema":{"type":"string","x-fhir-type":"code"}},{"name":"codeB","in":"query","description":"The second code","schema":{"type":"string","x-fhir-type":"code"}},{"name":"system","in":"query","description":"Their code system (type level)","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"version","in":"query","description":"Its version","schema":{"type":"string","x-fhir-type":"string"}},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["CodeSystem"],"operationId":"subsumesCodeSystemPost","summary":"Does one code subsume another?","description":"Tests the relationship between two codes in a code system.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `codeA` | `code` | 0..1 | The first code |\n| `codeB` | `code` | 0..1 | The second code |\n| `system` | `uri` | 0..1 | Their code system (type level) |\n| `version` | `string` | 0..1 | Its version |\n| `codingA` | Coding | 0..1 | The first code, as a Coding (POST, in a Parameters resource, only) |\n| `codingB` | Coding | 0..1 | The second code, as a Coding (POST, in a Parameters resource, only) |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `outcome` | `code` | 1..1 | `equivalent`, `subsumes`, `subsumed-by` or `not-subsumed` |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"codeA":{"type":"string","x-fhir-type":"code"},"codeB":{"type":"string","x-fhir-type":"code"},"system":{"type":"string","x-fhir-type":"uri"},"version":{"type":"string","x-fhir-type":"string"},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/CodeSystem/{id}/$subsumes":{"get":{"tags":["CodeSystem"],"operationId":"subsumesCodeSystemInstance","summary":"Does one code subsume another?","description":"Tests the relationship between two codes in a code system.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `codeA` | `code` | 0..1 | The first code |\n| `codeB` | `code` | 0..1 | The second code |\n| `system` | `uri` | 0..1 | Their code system (type level) |\n| `version` | `string` | 0..1 | Its version |\n| `codingA` | Coding | 0..1 | The first code, as a Coding (POST, in a Parameters resource, only) |\n| `codingB` | Coding | 0..1 | The second code, as a Coding (POST, in a Parameters resource, only) |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `outcome` | `code` | 1..1 | `equivalent`, `subsumes`, `subsumed-by` or `not-subsumed` |\n\nThe CodeSystem is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"codeA","in":"query","description":"The first code","schema":{"type":"string","x-fhir-type":"code"}},{"name":"codeB","in":"query","description":"The second code","schema":{"type":"string","x-fhir-type":"code"}},{"name":"system","in":"query","description":"Their code system (type level)","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"version","in":"query","description":"Its version","schema":{"type":"string","x-fhir-type":"string"}},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["CodeSystem"],"operationId":"subsumesCodeSystemInstancePost","summary":"Does one code subsume another?","description":"Tests the relationship between two codes in a code system.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `codeA` | `code` | 0..1 | The first code |\n| `codeB` | `code` | 0..1 | The second code |\n| `system` | `uri` | 0..1 | Their code system (type level) |\n| `version` | `string` | 0..1 | Its version |\n| `codingA` | Coding | 0..1 | The first code, as a Coding (POST, in a Parameters resource, only) |\n| `codingB` | Coding | 0..1 | The second code, as a Coding (POST, in a Parameters resource, only) |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `outcome` | `code` | 1..1 | `equivalent`, `subsumes`, `subsumed-by` or `not-subsumed` |\n\nThe CodeSystem is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"codeA":{"type":"string","x-fhir-type":"code"},"codeB":{"type":"string","x-fhir-type":"code"},"system":{"type":"string","x-fhir-type":"uri"},"version":{"type":"string","x-fhir-type":"string"},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/ConceptMap/$translate":{"get":{"tags":["ConceptMap"],"operationId":"translateConceptMap","summary":"Translate a code","description":"Translates a code using a concept map: the one named by url (or the instance), or the ones the server has that map between the source and target. The R5 names are used here; the R4 names (code, coding, codeableConcept, system, version, source, target, targetsystem, reverse) are accepted too.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The concept map (type level) |\n| `conceptMapVersion` | `string` | 0..1 | Its version |\n| `sourceCode` | `code` | 0..1 | The code to translate (with sourceSystem) |\n| `sourceSystem` | `uri` | 0..1 | Its code system |\n| `sourceVersion` | `string` | 0..1 | The version of the code system |\n| `sourceCoding` | Coding | 0..1 | The code to translate, as a Coding (POST, in a Parameters resource, only) |\n| `sourceCodeableConcept` | CodeableConcept | 0..1 | The code to translate, as a CodeableConcept (its first coding) (POST, in a Parameters resource, only) |\n| `targetCode` | `code` | 0..1 | A target code to translate back from (with targetSystem) |\n| `targetCoding` | Coding | 0..1 | A target code to translate back from, as a Coding (POST, in a Parameters resource, only) |\n| `targetCodeableConcept` | CodeableConcept | 0..1 | A target code to translate back from, as a CodeableConcept (POST, in a Parameters resource, only) |\n| `targetVersion` | `string` | 0..1 | The version of the target code system |\n| `sourceScope` | `uri` | 0..1 | The value set the source is in |\n| `targetScope` | `uri` | 0..1 | The value set to translate into |\n| `targetSystem` | `uri` | 0..1 | The code system to translate into |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `boolean` | 1..1 | Whether there's a translation |\n| `message` | `string` | 0..1 | More about the result |\n| `match` | parts | 0..* | A translation |\n| &nbsp;&nbsp;`match.relationship` | `code` | 0..1 | How the target relates to the source |\n| &nbsp;&nbsp;`match.concept` | Coding | 0..1 | The target |\n| &nbsp;&nbsp;`match.product` | parts | 0..* | Another element of the product (element, concept) |\n| &nbsp;&nbsp;`match.originMap` | `canonical` | 0..1 | The concept map |\n| &nbsp;&nbsp;`match.sourceConcept` | Coding | 0..1 | What was translated (for a translation in reverse) |\n| `used-conceptmap` | `canonical` | 0..* | A concept map that was used |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"url","in":"query","description":"The concept map (type level)","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"conceptMapVersion","in":"query","description":"Its version","schema":{"type":"string","x-fhir-type":"string"}},{"name":"sourceCode","in":"query","description":"The code to translate (with sourceSystem)","schema":{"type":"string","x-fhir-type":"code"}},{"name":"sourceSystem","in":"query","description":"Its code system","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"sourceVersion","in":"query","description":"The version of the code system","schema":{"type":"string","x-fhir-type":"string"}},{"name":"targetCode","in":"query","description":"A target code to translate back from (with targetSystem)","schema":{"type":"string","x-fhir-type":"code"}},{"name":"targetVersion","in":"query","description":"The version of the target code system","schema":{"type":"string","x-fhir-type":"string"}},{"name":"sourceScope","in":"query","description":"The value set the source is in","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"targetScope","in":"query","description":"The value set to translate into","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"targetSystem","in":"query","description":"The code system to translate into","schema":{"type":"string","x-fhir-type":"uri"}},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["ConceptMap"],"operationId":"translateConceptMapPost","summary":"Translate a code","description":"Translates a code using a concept map: the one named by url (or the instance), or the ones the server has that map between the source and target. The R5 names are used here; the R4 names (code, coding, codeableConcept, system, version, source, target, targetsystem, reverse) are accepted too.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The concept map (type level) |\n| `conceptMapVersion` | `string` | 0..1 | Its version |\n| `sourceCode` | `code` | 0..1 | The code to translate (with sourceSystem) |\n| `sourceSystem` | `uri` | 0..1 | Its code system |\n| `sourceVersion` | `string` | 0..1 | The version of the code system |\n| `sourceCoding` | Coding | 0..1 | The code to translate, as a Coding (POST, in a Parameters resource, only) |\n| `sourceCodeableConcept` | CodeableConcept | 0..1 | The code to translate, as a CodeableConcept (its first coding) (POST, in a Parameters resource, only) |\n| `targetCode` | `code` | 0..1 | A target code to translate back from (with targetSystem) |\n| `targetCoding` | Coding | 0..1 | A target code to translate back from, as a Coding (POST, in a Parameters resource, only) |\n| `targetCodeableConcept` | CodeableConcept | 0..1 | A target code to translate back from, as a CodeableConcept (POST, in a Parameters resource, only) |\n| `targetVersion` | `string` | 0..1 | The version of the target code system |\n| `sourceScope` | `uri` | 0..1 | The value set the source is in |\n| `targetScope` | `uri` | 0..1 | The value set to translate into |\n| `targetSystem` | `uri` | 0..1 | The code system to translate into |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `boolean` | 1..1 | Whether there's a translation |\n| `message` | `string` | 0..1 | More about the result |\n| `match` | parts | 0..* | A translation |\n| &nbsp;&nbsp;`match.relationship` | `code` | 0..1 | How the target relates to the source |\n| &nbsp;&nbsp;`match.concept` | Coding | 0..1 | The target |\n| &nbsp;&nbsp;`match.product` | parts | 0..* | Another element of the product (element, concept) |\n| &nbsp;&nbsp;`match.originMap` | `canonical` | 0..1 | The concept map |\n| &nbsp;&nbsp;`match.sourceConcept` | Coding | 0..1 | What was translated (for a translation in reverse) |\n| `used-conceptmap` | `canonical` | 0..* | A concept map that was used |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"url":{"type":"string","x-fhir-type":"uri"},"conceptMapVersion":{"type":"string","x-fhir-type":"string"},"sourceCode":{"type":"string","x-fhir-type":"code"},"sourceSystem":{"type":"string","x-fhir-type":"uri"},"sourceVersion":{"type":"string","x-fhir-type":"string"},"targetCode":{"type":"string","x-fhir-type":"code"},"targetVersion":{"type":"string","x-fhir-type":"string"},"sourceScope":{"type":"string","x-fhir-type":"uri"},"targetScope":{"type":"string","x-fhir-type":"uri"},"targetSystem":{"type":"string","x-fhir-type":"uri"},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/ConceptMap/{id}/$translate":{"get":{"tags":["ConceptMap"],"operationId":"translateConceptMapInstance","summary":"Translate a code","description":"Translates a code using a concept map: the one named by url (or the instance), or the ones the server has that map between the source and target. The R5 names are used here; the R4 names (code, coding, codeableConcept, system, version, source, target, targetsystem, reverse) are accepted too.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The concept map (type level) |\n| `conceptMapVersion` | `string` | 0..1 | Its version |\n| `sourceCode` | `code` | 0..1 | The code to translate (with sourceSystem) |\n| `sourceSystem` | `uri` | 0..1 | Its code system |\n| `sourceVersion` | `string` | 0..1 | The version of the code system |\n| `sourceCoding` | Coding | 0..1 | The code to translate, as a Coding (POST, in a Parameters resource, only) |\n| `sourceCodeableConcept` | CodeableConcept | 0..1 | The code to translate, as a CodeableConcept (its first coding) (POST, in a Parameters resource, only) |\n| `targetCode` | `code` | 0..1 | A target code to translate back from (with targetSystem) |\n| `targetCoding` | Coding | 0..1 | A target code to translate back from, as a Coding (POST, in a Parameters resource, only) |\n| `targetCodeableConcept` | CodeableConcept | 0..1 | A target code to translate back from, as a CodeableConcept (POST, in a Parameters resource, only) |\n| `targetVersion` | `string` | 0..1 | The version of the target code system |\n| `sourceScope` | `uri` | 0..1 | The value set the source is in |\n| `targetScope` | `uri` | 0..1 | The value set to translate into |\n| `targetSystem` | `uri` | 0..1 | The code system to translate into |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `boolean` | 1..1 | Whether there's a translation |\n| `message` | `string` | 0..1 | More about the result |\n| `match` | parts | 0..* | A translation |\n| &nbsp;&nbsp;`match.relationship` | `code` | 0..1 | How the target relates to the source |\n| &nbsp;&nbsp;`match.concept` | Coding | 0..1 | The target |\n| &nbsp;&nbsp;`match.product` | parts | 0..* | Another element of the product (element, concept) |\n| &nbsp;&nbsp;`match.originMap` | `canonical` | 0..1 | The concept map |\n| &nbsp;&nbsp;`match.sourceConcept` | Coding | 0..1 | What was translated (for a translation in reverse) |\n| `used-conceptmap` | `canonical` | 0..* | A concept map that was used |\n\nThe ConceptMap is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"url","in":"query","description":"The concept map (type level)","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"conceptMapVersion","in":"query","description":"Its version","schema":{"type":"string","x-fhir-type":"string"}},{"name":"sourceCode","in":"query","description":"The code to translate (with sourceSystem)","schema":{"type":"string","x-fhir-type":"code"}},{"name":"sourceSystem","in":"query","description":"Its code system","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"sourceVersion","in":"query","description":"The version of the code system","schema":{"type":"string","x-fhir-type":"string"}},{"name":"targetCode","in":"query","description":"A target code to translate back from (with targetSystem)","schema":{"type":"string","x-fhir-type":"code"}},{"name":"targetVersion","in":"query","description":"The version of the target code system","schema":{"type":"string","x-fhir-type":"string"}},{"name":"sourceScope","in":"query","description":"The value set the source is in","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"targetScope","in":"query","description":"The value set to translate into","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"targetSystem","in":"query","description":"The code system to translate into","schema":{"type":"string","x-fhir-type":"uri"}},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["ConceptMap"],"operationId":"translateConceptMapInstancePost","summary":"Translate a code","description":"Translates a code using a concept map: the one named by url (or the instance), or the ones the server has that map between the source and target. The R5 names are used here; the R4 names (code, coding, codeableConcept, system, version, source, target, targetsystem, reverse) are accepted too.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `url` | `uri` | 0..1 | The concept map (type level) |\n| `conceptMapVersion` | `string` | 0..1 | Its version |\n| `sourceCode` | `code` | 0..1 | The code to translate (with sourceSystem) |\n| `sourceSystem` | `uri` | 0..1 | Its code system |\n| `sourceVersion` | `string` | 0..1 | The version of the code system |\n| `sourceCoding` | Coding | 0..1 | The code to translate, as a Coding (POST, in a Parameters resource, only) |\n| `sourceCodeableConcept` | CodeableConcept | 0..1 | The code to translate, as a CodeableConcept (its first coding) (POST, in a Parameters resource, only) |\n| `targetCode` | `code` | 0..1 | A target code to translate back from (with targetSystem) |\n| `targetCoding` | Coding | 0..1 | A target code to translate back from, as a Coding (POST, in a Parameters resource, only) |\n| `targetCodeableConcept` | CodeableConcept | 0..1 | A target code to translate back from, as a CodeableConcept (POST, in a Parameters resource, only) |\n| `targetVersion` | `string` | 0..1 | The version of the target code system |\n| `sourceScope` | `uri` | 0..1 | The value set the source is in |\n| `targetScope` | `uri` | 0..1 | The value set to translate into |\n| `targetSystem` | `uri` | 0..1 | The code system to translate into |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `boolean` | 1..1 | Whether there's a translation |\n| `message` | `string` | 0..1 | More about the result |\n| `match` | parts | 0..* | A translation |\n| &nbsp;&nbsp;`match.relationship` | `code` | 0..1 | How the target relates to the source |\n| &nbsp;&nbsp;`match.concept` | Coding | 0..1 | The target |\n| &nbsp;&nbsp;`match.product` | parts | 0..* | Another element of the product (element, concept) |\n| &nbsp;&nbsp;`match.originMap` | `canonical` | 0..1 | The concept map |\n| &nbsp;&nbsp;`match.sourceConcept` | Coding | 0..1 | What was translated (for a translation in reverse) |\n| `used-conceptmap` | `canonical` | 0..* | A concept map that was used |\n\nThe ConceptMap is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"url":{"type":"string","x-fhir-type":"uri"},"conceptMapVersion":{"type":"string","x-fhir-type":"string"},"sourceCode":{"type":"string","x-fhir-type":"code"},"sourceSystem":{"type":"string","x-fhir-type":"uri"},"sourceVersion":{"type":"string","x-fhir-type":"string"},"targetCode":{"type":"string","x-fhir-type":"code"},"targetVersion":{"type":"string","x-fhir-type":"string"},"sourceScope":{"type":"string","x-fhir-type":"uri"},"targetScope":{"type":"string","x-fhir-type":"uri"},"targetSystem":{"type":"string","x-fhir-type":"uri"},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/ValueSet/$compare":{"get":{"tags":["ValueSet"],"operationId":"compareValueSet","summary":"Compare two value sets","description":"Compares two value sets: by their definitions where that's enough, and otherwise by their expansions. At the instance level, the instance is `this`.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `thisUrl` | `uri` | 0..1 | The first value set |\n| `thisValueSet` | ValueSet | 0..1 | The first value set, sent with the request (POST, in a Parameters resource, only) |\n| `otherUrl` | `uri` | 0..1 | The second value set |\n| `otherValueSet` | ValueSet | 0..1 | The second value set, sent with the request (POST, in a Parameters resource, only) |\n| `valueSetVersion` | `string` | 0..1 | The version of a value set named by url |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `code` | 1..1 | `same`, `superset`, `subset`, `overlapping`, `disjoint`, `empty` or `indeterminate` |\n| `message` | `string` | 0..1 | The result, as text |\n| `missing-codes` | `string` | 0..1 | diagnostics: the codes in the first value set and not the second (comma separated) |\n| `extra-codes` | `string` | 0..1 | diagnostics: the codes in the second value set and not the first (comma separated) |\n| `common-codes` | `string` | 0..1 | diagnostics: the codes in both (comma separated) |\n| `performed-expansion` | `boolean` | 0..1 | diagnostics: whether the value sets had to be expanded |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"thisUrl","in":"query","description":"The first value set","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"otherUrl","in":"query","description":"The second value set","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"valueSetVersion","in":"query","description":"The version of a value set named by url","schema":{"type":"string","x-fhir-type":"string"}},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["ValueSet"],"operationId":"compareValueSetPost","summary":"Compare two value sets","description":"Compares two value sets: by their definitions where that's enough, and otherwise by their expansions. At the instance level, the instance is `this`.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `thisUrl` | `uri` | 0..1 | The first value set |\n| `thisValueSet` | ValueSet | 0..1 | The first value set, sent with the request (POST, in a Parameters resource, only) |\n| `otherUrl` | `uri` | 0..1 | The second value set |\n| `otherValueSet` | ValueSet | 0..1 | The second value set, sent with the request (POST, in a Parameters resource, only) |\n| `valueSetVersion` | `string` | 0..1 | The version of a value set named by url |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `code` | 1..1 | `same`, `superset`, `subset`, `overlapping`, `disjoint`, `empty` or `indeterminate` |\n| `message` | `string` | 0..1 | The result, as text |\n| `missing-codes` | `string` | 0..1 | diagnostics: the codes in the first value set and not the second (comma separated) |\n| `extra-codes` | `string` | 0..1 | diagnostics: the codes in the second value set and not the first (comma separated) |\n| `common-codes` | `string` | 0..1 | diagnostics: the codes in both (comma separated) |\n| `performed-expansion` | `boolean` | 0..1 | diagnostics: whether the value sets had to be expanded |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"thisUrl":{"type":"string","x-fhir-type":"uri"},"otherUrl":{"type":"string","x-fhir-type":"uri"},"valueSetVersion":{"type":"string","x-fhir-type":"string"},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/ValueSet/{id}/$compare":{"get":{"tags":["ValueSet"],"operationId":"compareValueSetInstance","summary":"Compare two value sets","description":"Compares two value sets: by their definitions where that's enough, and otherwise by their expansions. At the instance level, the instance is `this`.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `thisUrl` | `uri` | 0..1 | The first value set |\n| `thisValueSet` | ValueSet | 0..1 | The first value set, sent with the request (POST, in a Parameters resource, only) |\n| `otherUrl` | `uri` | 0..1 | The second value set |\n| `otherValueSet` | ValueSet | 0..1 | The second value set, sent with the request (POST, in a Parameters resource, only) |\n| `valueSetVersion` | `string` | 0..1 | The version of a value set named by url |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `code` | 1..1 | `same`, `superset`, `subset`, `overlapping`, `disjoint`, `empty` or `indeterminate` |\n| `message` | `string` | 0..1 | The result, as text |\n| `missing-codes` | `string` | 0..1 | diagnostics: the codes in the first value set and not the second (comma separated) |\n| `extra-codes` | `string` | 0..1 | diagnostics: the codes in the second value set and not the first (comma separated) |\n| `common-codes` | `string` | 0..1 | diagnostics: the codes in both (comma separated) |\n| `performed-expansion` | `boolean` | 0..1 | diagnostics: whether the value sets had to be expanded |\n\nThe ValueSet is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"thisUrl","in":"query","description":"The first value set","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"otherUrl","in":"query","description":"The second value set","schema":{"type":"string","x-fhir-type":"uri"}},{"name":"valueSetVersion","in":"query","description":"The version of a value set named by url","schema":{"type":"string","x-fhir-type":"string"}},{"$ref":"#/components/parameters/common-cache-id"},{"$ref":"#/components/parameters/common-system-version"},{"$ref":"#/components/parameters/common-check-system-version"},{"$ref":"#/components/parameters/common-force-system-version"},{"$ref":"#/components/parameters/common-default-valueset-version"},{"$ref":"#/components/parameters/common-check-valueset-version"},{"$ref":"#/components/parameters/common-force-valueset-version"},{"$ref":"#/components/parameters/common-default-to-latest-version"},{"$ref":"#/components/parameters/common-displayLanguage"},{"$ref":"#/components/parameters/common-useSupplement"},{"$ref":"#/components/parameters/common-no-cache"},{"$ref":"#/components/parameters/common-diagnostics"}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["ValueSet"],"operationId":"compareValueSetInstancePost","summary":"Compare two value sets","description":"Compares two value sets: by their definitions where that's enough, and otherwise by their expansions. At the instance level, the instance is `this`.\n\n**In parameters** (and the common parameters - see the overview)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `thisUrl` | `uri` | 0..1 | The first value set |\n| `thisValueSet` | ValueSet | 0..1 | The first value set, sent with the request (POST, in a Parameters resource, only) |\n| `otherUrl` | `uri` | 0..1 | The second value set |\n| `otherValueSet` | ValueSet | 0..1 | The second value set, sent with the request (POST, in a Parameters resource, only) |\n| `valueSetVersion` | `string` | 0..1 | The version of a value set named by url |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `result` | `code` | 1..1 | `same`, `superset`, `subset`, `overlapping`, `disjoint`, `empty` or `indeterminate` |\n| `message` | `string` | 0..1 | The result, as text |\n| `missing-codes` | `string` | 0..1 | diagnostics: the codes in the first value set and not the second (comma separated) |\n| `extra-codes` | `string` | 0..1 | diagnostics: the codes in the second value set and not the first (comma separated) |\n| `common-codes` | `string` | 0..1 | diagnostics: the codes in both (comma separated) |\n| `performed-expansion` | `boolean` | 0..1 | diagnostics: whether the value sets had to be expanded |\n\nThe ValueSet is the one with this id.","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"thisUrl":{"type":"string","x-fhir-type":"uri"},"otherUrl":{"type":"string","x-fhir-type":"uri"},"valueSetVersion":{"type":"string","x-fhir-type":"string"},"cache-id":{"type":"string","x-fhir-type":"id"},"system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-system-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"check-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"force-valueset-version":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"default-to-latest-version":{"type":"boolean"},"displayLanguage":{"type":"string","x-fhir-type":"code"},"useSupplement":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"no-cache":{"type":"boolean"},"diagnostics":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/$closure":{"post":{"tags":["Server"],"operationId":"closure","summary":"Maintain a closure table","description":"Adds concepts to a named closure table, and returns the new relationships, as a ConceptMap. Only POST: the operation changes the table. Not every server keeps closure tables (501 if not).\n\n**In parameters**\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `name` | `string` | 1..1 | The closure table |\n| `concept` | Coding | 0..* | A concept to add (POST, in a Parameters resource, only) |\n| `version` | `string` | 0..1 | Return the changes since this version of the table, instead of adding concepts |\n| `reset` | `boolean` | 0..1 | Start the table again |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"type":"string","x-fhir-type":"string"},"version":{"type":"string","x-fhir-type":"string"},"reset":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The new relationships","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/ConceptMap"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConceptMap"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}},"/$cache-control":{"get":{"tags":["Server"],"operationId":"cacheControl","summary":"Manage a cache of resources","description":"A client that sends the same tx-resources with many requests can keep them in a cache on the server instead. `mode=start` creates a cache (with the tx-resources sent with it) and returns its id; later requests send the id in the `X-Cache-Id` header. `mode=check` reports whether the cache is still there (and keeps it alive); `mode=end` releases it. Caches expire when they aren't used.\n\n**In parameters**\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `mode` | `code` | 1..1 | `start`, `check` or `end` (in the query, even for a POST) |\n| `sealed` | `boolean` | 0..1 | start: whether the cache holds only what's sent now (default false: it grows with the tx-resources later requests send) |\n| `tx-resource` | Resource | 0..* | start: resources to put in the cache (POST, in a Parameters resource, only) |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `cache-id` | `id` | 0..1 | start: the new cache's id; check: the cache checked |\n| `sealed` | `boolean` | 0..1 | start, check: whether it's sealed |\n| `valid` | `boolean` | 0..1 | check: whether the cache is still there |\n| `outcome` | OperationOutcome | 0..1 | check: why it isn't (when valid is false) |\n| `resource-count` | `unsignedInt` | 0..1 | check: how many resources it holds |\n| `idle` | `unsignedInt` | 0..1 | check: how long it has been unused (seconds) |\n| `timeout` | `unsignedInt` | 0..1 | check: how long it can be unused before it expires (seconds) |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"mode","in":"query","description":"`start`, `check` or `end` (in the query, even for a POST)","schema":{"type":"string","x-fhir-type":"code"},"required":true},{"name":"sealed","in":"query","description":"start: whether the cache holds only what's sent now (default false: it grows with the tx-resources later requests send)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}},"post":{"tags":["Server"],"operationId":"cacheControlPost","summary":"Manage a cache of resources","description":"A client that sends the same tx-resources with many requests can keep them in a cache on the server instead. `mode=start` creates a cache (with the tx-resources sent with it) and returns its id; later requests send the id in the `X-Cache-Id` header. `mode=check` reports whether the cache is still there (and keeps it alive); `mode=end` releases it. Caches expire when they aren't used.\n\n**In parameters**\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `mode` | `code` | 1..1 | `start`, `check` or `end` (in the query, even for a POST) |\n| `sealed` | `boolean` | 0..1 | start: whether the cache holds only what's sent now (default false: it grows with the tx-resources later requests send) |\n| `tx-resource` | Resource | 0..* | start: resources to put in the cache (POST, in a Parameters resource, only) |\n\n**Out parameters** (a Parameters resource)\n\n| Name | Type | Card. | Description |\n|---|---|---|---|\n| `cache-id` | `id` | 0..1 | start: the new cache's id; check: the cache checked |\n| `sealed` | `boolean` | 0..1 | start, check: whether it's sealed |\n| `valid` | `boolean` | 0..1 | check: whether the cache is still there |\n| `outcome` | OperationOutcome | 0..1 | check: why it isn't (when valid is false) |\n| `resource-count` | `unsignedInt` | 0..1 | check: how many resources it holds |\n| `idle` | `unsignedInt` | 0..1 | check: how long it has been unused (seconds) |\n| `timeout` | `unsignedInt` | 0..1 | check: how long it can be unused before it expires (seconds) |","parameters":[{"$ref":"#/components/parameters/acceptLanguage"},{"$ref":"#/components/parameters/cacheId"},{"$ref":"#/components/parameters/format"},{"name":"mode","in":"query","description":"`start`, `check` or `end` (in the query, even for a POST)","required":true,"schema":{"type":"string","x-fhir-type":"code"}}],"requestBody":{"required":true,"description":"The in parameters, as a Parameters resource (or a form)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"sealed":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The out parameters (see the table)","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/Parameters"}},"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}}},"400":{"$ref":"#/components/responses/Outcome","description":"The request is not valid"},"404":{"$ref":"#/components/responses/Outcome","description":"Something the request names was not found"},"422":{"$ref":"#/components/responses/Outcome","description":"The request could not be processed (e.g. the value set is not valid, or the expansion is too large)"},"500":{"$ref":"#/components/responses/Outcome","description":"The server failed"}}}}},"components":{"parameters":{"id":{"name":"id","in":"path","required":true,"description":"The resource's id","schema":{"type":"string"}},"format":{"name":"_format","in":"query","description":"`json`, `xml` or `html`, instead of the Accept header","schema":{"type":"string","enum":["json","xml","html"]}},"acceptLanguage":{"name":"Accept-Language","in":"header","description":"The language(s) for displays and messages","schema":{"type":"string"},"example":"en"},"cacheId":{"name":"X-Cache-Id","in":"header","description":"A cache of resources, started with $cache-control","schema":{"type":"string"}},"common-cache-id":{"name":"cache-id","in":"query","description":"A cache of tx-resources started with $cache-control (mode=start). Sending it in the `X-Cache-Id` header instead is preferred","schema":{"type":"string","x-fhir-type":"id"}},"common-system-version":{"name":"system-version","in":"query","description":"The version of a code system to use when the value set (or the request) doesn't say: `system|version`","schema":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"style":"form","explode":true},"common-check-system-version":{"name":"check-system-version","in":"query","description":"The version of a code system that must be used: `system|version`. It's an error if anything else would be","schema":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"style":"form","explode":true},"common-force-system-version":{"name":"force-system-version","in":"query","description":"The version of a code system to use, whatever the value set (or the request) says: `system|version`","schema":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"style":"form","explode":true},"common-default-valueset-version":{"name":"default-valueset-version","in":"query","description":"The version of a value set to use when a reference to it doesn't say: `url|version`","schema":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"style":"form","explode":true},"common-check-valueset-version":{"name":"check-valueset-version","in":"query","description":"The version of a value set that must be used: `url|version`","schema":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"style":"form","explode":true},"common-force-valueset-version":{"name":"force-valueset-version","in":"query","description":"The version of a value set to use, whatever the reference to it says: `url|version`","schema":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"style":"form","explode":true},"common-default-to-latest-version":{"name":"default-to-latest-version","in":"query","description":"When no version is specified, use the latest the server has","schema":{"type":"boolean"}},"common-displayLanguage":{"name":"displayLanguage","in":"query","description":"The language(s) for displays, in the form of an HTTP Accept-Language (which is used if this isn't present)","schema":{"type":"string","x-fhir-type":"code"}},"common-useSupplement":{"name":"useSupplement","in":"query","description":"A code system supplement to use, which must then be used (`url` or `url|version`)","schema":{"type":"array","items":{"type":"string","x-fhir-type":"canonical"}},"style":"form","explode":true},"common-no-cache":{"name":"no-cache","in":"query","description":"Don't answer from a cached result","schema":{"type":"boolean"}},"common-diagnostics":{"name":"diagnostics","in":"query","description":"Add the server's working to the response (for debugging; the format can change at any time)","schema":{"type":"boolean"}}},"responses":{"Outcome":{"description":"An error, as an OperationOutcome","content":{"application/fhir+json":{"schema":{"$ref":"#/components/schemas/OperationOutcome"}}}}},"schemas":{"Attachment":{"type":"object","description":"Attachment Type: For referring to data content defined in other formats.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"contentType":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Mime type of the content, with charset etc."},"_contentType":{"$ref":"#/components/schemas/Element"},"language":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Human language of the content (BCP-47)"},"_language":{"$ref":"#/components/schemas/Element"},"data":{"x-fhir-type":"base64Binary","type":"string","pattern":"^((?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?)$","description":"Data inline, base64ed"},"_data":{"$ref":"#/components/schemas/Element"},"url":{"x-fhir-type":"url","type":"string","pattern":"^(\\S*)$","description":"Uri where the data can be found"},"_url":{"$ref":"#/components/schemas/Element"},"size":{"x-fhir-type":"integer64","type":"string","pattern":"^([0]|[-+]?[1-9][0-9]*)$","description":"Number of bytes of content (if url provided)"},"_size":{"$ref":"#/components/schemas/Element"},"hash":{"x-fhir-type":"base64Binary","type":"string","pattern":"^((?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?)$","description":"Hash of the data (sha-1, base64ed)"},"_hash":{"$ref":"#/components/schemas/Element"},"title":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Label to display in place of the data"},"_title":{"$ref":"#/components/schemas/Element"},"creation":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Date attachment was first created"},"_creation":{"$ref":"#/components/schemas/Element"},"height":{"x-fhir-type":"positiveInt","type":"integer","minimum":1,"description":"Height of the image in pixels (photo/video)"},"_height":{"$ref":"#/components/schemas/Element"},"width":{"x-fhir-type":"positiveInt","type":"integer","minimum":1,"description":"Width of the image in pixels (photo/video)"},"_width":{"$ref":"#/components/schemas/Element"},"frames":{"x-fhir-type":"positiveInt","type":"integer","minimum":1,"description":"Number of frames if > 1 (photo)"},"_frames":{"$ref":"#/components/schemas/Element"},"duration":{"x-fhir-type":"decimal","type":"number","description":"Length in seconds (audio / video)"},"_duration":{"$ref":"#/components/schemas/Element"},"pages":{"x-fhir-type":"positiveInt","type":"integer","minimum":1,"description":"Number of printed pages"},"_pages":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"Bundle":{"type":"object","description":"A container for a collection of resources.","properties":{"resourceType":{"const":"Bundle"},"id":{"type":"string","description":"Logical id of this artifact"},"meta":{"$ref":"#/components/schemas/Meta","description":"Metadata about the resource"},"implicitRules":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"A set of rules under which this content was created"},"_implicitRules":{"$ref":"#/components/schemas/Element"},"language":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Language of the resource content"},"_language":{"$ref":"#/components/schemas/Element"},"identifier":{"$ref":"#/components/schemas/Identifier","description":"Persistent identifier for the bundle"},"type":{"x-fhir-type":"code","type":"string","enum":["document","message","transaction","transaction-response","batch","batch-response","history","searchset","collection","subscription-notification"],"description":"document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification"},"_type":{"$ref":"#/components/schemas/Element"},"timestamp":{"x-fhir-type":"instant","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))$","description":"When the bundle was assembled"},"_timestamp":{"$ref":"#/components/schemas/Element"},"total":{"x-fhir-type":"unsignedInt","type":"integer","minimum":0,"description":"If search, the total number of matches"},"_total":{"$ref":"#/components/schemas/Element"},"link":{"type":"array","description":"Links related to this Bundle","items":{"$ref":"#/components/schemas/Bundle_Link"}},"entry":{"type":"array","description":"Entry in the bundle - will have a resource or information","items":{"$ref":"#/components/schemas/Bundle_Entry"}},"signature":{"$ref":"#/components/schemas/Signature","description":"Digital Signature"},"issues":{"$ref":"#/components/schemas/OperationOutcome","description":"Issues with the Bundle"}},"required":["resourceType","type"],"additionalProperties":false},"Bundle_Entry":{"type":"object","description":"An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"link":{"type":"array","description":"Links related to this entry","items":{"$ref":"#/components/schemas/Bundle_Link"}},"fullUrl":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)"},"_fullUrl":{"$ref":"#/components/schemas/Element"},"resource":{"anyOf":[{"$ref":"#/components/schemas/CodeSystem"},{"$ref":"#/components/schemas/ValueSet"},{"$ref":"#/components/schemas/ConceptMap"},{"$ref":"#/components/schemas/OperationOutcome"}],"description":"A resource in the bundle"},"search":{"$ref":"#/components/schemas/Bundle_Entry_Search","description":"Search related information"},"request":{"$ref":"#/components/schemas/Bundle_Entry_Request","description":"Additional execution information (transaction/batch/history)"},"response":{"$ref":"#/components/schemas/Bundle_Entry_Response","description":"Results of execution (transaction/batch/history)"}},"additionalProperties":false},"Bundle_Entry_Request":{"type":"object","description":"Additional information about how this entry should be processed as part of a transaction or batch.  For history, it shows how the entry was processed to create the version contained in the entry.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"method":{"x-fhir-type":"code","type":"string","enum":["GET","HEAD","POST","PUT","DELETE","PATCH"],"description":"GET | HEAD | POST | PUT | DELETE | PATCH"},"_method":{"$ref":"#/components/schemas/Element"},"url":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"URL for HTTP equivalent of this entry"},"_url":{"$ref":"#/components/schemas/Element"},"ifNoneMatch":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"For managing cache validation"},"_ifNoneMatch":{"$ref":"#/components/schemas/Element"},"ifModifiedSince":{"x-fhir-type":"instant","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))$","description":"For managing cache currency"},"_ifModifiedSince":{"$ref":"#/components/schemas/Element"},"ifMatch":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"For managing update contention"},"_ifMatch":{"$ref":"#/components/schemas/Element"},"ifNoneExist":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"For conditional creates"},"_ifNoneExist":{"$ref":"#/components/schemas/Element"}},"required":["method","url"],"additionalProperties":false},"Bundle_Entry_Response":{"type":"object","description":"Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"status":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Status response code (text optional)"},"_status":{"$ref":"#/components/schemas/Element"},"location":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"The location (if the operation returns a location)"},"_location":{"$ref":"#/components/schemas/Element"},"etag":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"The Etag for the resource (if relevant)"},"_etag":{"$ref":"#/components/schemas/Element"},"lastModified":{"x-fhir-type":"instant","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))$","description":"Server's date time modified"},"_lastModified":{"$ref":"#/components/schemas/Element"},"outcome":{"$ref":"#/components/schemas/OperationOutcome","description":"OperationOutcome with hints and warnings (for batch/transaction)"}},"required":["status"],"additionalProperties":false},"Bundle_Entry_Search":{"type":"object","description":"Information about the search process that lead to the creation of this entry.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"mode":{"x-fhir-type":"code","type":"string","enum":["match","include","outcome"],"description":"match | include - why this is in the result set"},"_mode":{"$ref":"#/components/schemas/Element"},"score":{"x-fhir-type":"decimal","type":"number","description":"Search ranking (between 0 and 1)"},"_score":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"Bundle_Link":{"type":"object","description":"A series of links that provide context to this bundle.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"relation":{"x-fhir-type":"code","type":"string","enum":["about","acl","alternate","amphtml","appendix","apple-touch-icon","apple-touch-startup-image","archives","author","blocked-by","bookmark","canonical","chapter","cite-as","collection","contents","convertedFrom","copyright","create-form","current","describedby","describes","disclosure","dns-prefetch","duplicate","edit","edit-form","edit-media","enclosure","external","first","glossary","help","hosts","hub","icon","index","intervalAfter","intervalBefore","intervalContains","intervalDisjoint","intervalDuring","intervalEquals","intervalFinishedBy","intervalFinishes","intervalIn","intervalMeets","intervalMetBy","intervalOverlappedBy","intervalOverlaps","intervalStartedBy","intervalStarts","item","last","latest-version","license","linkset","lrdd","manifest","mask-icon","media-feed","memento","micropub","modulepreload","monitor","monitor-group","next","next-archive","nofollow","noopener","noreferrer","opener","openid2.local_id","openid2.provider","original","P3Pv1","payment","pingback","preconnect","predecessor-version","prefetch","preload","prerender","prev","preview","previous","prev-archive","privacy-policy","profile","publication","related","restconf","replies","ruleinput","search","section","self","service","service-desc","service-doc","service-meta","sponsored","start","status","stylesheet","subsection","successor-version","sunset","tag","terms-of-service","timegate","timemap","type","ugc","up","version-history","via","webmention","working-copy","working-copy-of"],"description":"See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1"},"_relation":{"$ref":"#/components/schemas/Element"},"url":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Reference details for the link"},"_url":{"$ref":"#/components/schemas/Element"}},"required":["relation","url"],"additionalProperties":false},"CapabilityStatement":{"type":"object","description":"A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.","properties":{"resourceType":{"const":"CapabilityStatement"},"id":{"type":"string","description":"Logical id of this artifact"},"meta":{"$ref":"#/components/schemas/Meta","description":"Metadata about the resource"},"implicitRules":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"A set of rules under which this content was created"},"_implicitRules":{"$ref":"#/components/schemas/Element"},"language":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Language of the resource content"},"_language":{"$ref":"#/components/schemas/Element"},"text":{"$ref":"#/components/schemas/Narrative","description":"Text summary of the resource, for human interpretation"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored","items":{"$ref":"#/components/schemas/Extension"}},"url":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Canonical identifier for this capability statement, represented as a URI (globally unique)"},"_url":{"$ref":"#/components/schemas/Element"},"identifier":{"type":"array","description":"Additional identifier for the CapabilityStatement (business identifier)","items":{"$ref":"#/components/schemas/Identifier"}},"version":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Business version of the capability statement"},"_version":{"$ref":"#/components/schemas/Element"},"versionAlgorithmString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"How to compare versions"},"_versionAlgorithmString":{"$ref":"#/components/schemas/Element"},"versionAlgorithmCoding":{"$ref":"#/components/schemas/Coding","description":"How to compare versions"},"name":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name for this capability statement (computer friendly)"},"_name":{"$ref":"#/components/schemas/Element"},"title":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name for this capability statement (human friendly)"},"_title":{"$ref":"#/components/schemas/Element"},"status":{"x-fhir-type":"code","type":"string","enum":["draft","active","retired","unknown"],"description":"draft | active | retired | unknown"},"_status":{"$ref":"#/components/schemas/Element"},"experimental":{"x-fhir-type":"boolean","type":"boolean","description":"For testing purposes, not real usage"},"_experimental":{"$ref":"#/components/schemas/Element"},"date":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Date last changed"},"_date":{"$ref":"#/components/schemas/Element"},"publisher":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name of the publisher/steward (organization or individual)"},"_publisher":{"$ref":"#/components/schemas/Element"},"contact":{"type":"array","description":"Contact details for the publisher","items":{"$ref":"#/components/schemas/ContactDetail"}},"description":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Natural language description of the capability statement"},"_description":{"$ref":"#/components/schemas/Element"},"useContext":{"type":"array","description":"The context that the content is intended to support","items":{"$ref":"#/components/schemas/UsageContext"}},"jurisdiction":{"type":"array","description":"Intended jurisdiction for capability statement (if applicable)","items":{"$ref":"#/components/schemas/CodeableConcept"}},"purpose":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Why this capability statement is defined"},"_purpose":{"$ref":"#/components/schemas/Element"},"copyright":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Use and/or publishing restrictions"},"_copyright":{"$ref":"#/components/schemas/Element"},"copyrightLabel":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Copyright holder and year(s)"},"_copyrightLabel":{"$ref":"#/components/schemas/Element"},"kind":{"x-fhir-type":"code","type":"string","enum":["instance","capability","requirements"],"description":"instance | capability | requirements"},"_kind":{"$ref":"#/components/schemas/Element"},"instantiates":{"type":"array","description":"Canonical URL of another capability statement this implements","items":{"anyOf":[{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$"},{"type":"null"}]}},"_instantiates":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"imports":{"type":"array","description":"Canonical URL of another capability statement this adds to","items":{"anyOf":[{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$"},{"type":"null"}]}},"_imports":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"software":{"$ref":"#/components/schemas/CapabilityStatement_Software","description":"Software that is covered by this capability statement"},"implementation":{"$ref":"#/components/schemas/CapabilityStatement_Implementation","description":"If this describes a specific instance"},"fhirVersion":{"x-fhir-type":"code","type":"string","enum":["0.01","0.05","0.06","0.11","0.0","0.0.80","0.0.81","0.0.82","0.4","0.4.0","0.5","0.5.0","1.0","1.0.0","1.0.1","1.0.2","1.1","1.1.0","1.4","1.4.0","1.6","1.6.0","1.8","1.8.0","3.0","3.0.0","3.0.1","3.0.2","3.3","3.3.0","3.5","3.5.0","4.0","4.0.0","4.0.1","4.1","4.1.0","4.2","4.2.0","4.3","4.3.0","4.3.0-cibuild","4.3.0-snapshot1","4.4","4.4.0","4.5","4.5.0","4.6","4.6.0","5.0","5.0.0","5.0.0-cibuild","5.0.0-snapshot1","5.0.0-snapshot2","5.0.0-ballot","5.0.0-snapshot3","5.0.0-draft-final"],"description":"FHIR Version the system supports"},"_fhirVersion":{"$ref":"#/components/schemas/Element"},"format":{"type":"array","description":"formats supported (xml | json | ttl | mime type)","items":{"anyOf":[{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$"},{"type":"null"}]}},"_format":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"patchFormat":{"type":"array","description":"Patch formats supported","items":{"anyOf":[{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$"},{"type":"null"}]}},"_patchFormat":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"acceptLanguage":{"type":"array","description":"Languages supported","items":{"anyOf":[{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$"},{"type":"null"}]}},"_acceptLanguage":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"implementationGuide":{"type":"array","description":"Implementation guides supported","items":{"anyOf":[{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$"},{"type":"null"}]}},"_implementationGuide":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"rest":{"type":"array","description":"If the endpoint is a RESTful one","items":{"$ref":"#/components/schemas/CapabilityStatement_Rest"}},"messaging":{"type":"array","description":"If messaging is supported","items":{"$ref":"#/components/schemas/CapabilityStatement_Messaging"}},"document":{"type":"array","description":"Document definition","items":{"$ref":"#/components/schemas/CapabilityStatement_Document"}}},"required":["resourceType","status","date","kind","fhirVersion","format"],"additionalProperties":false},"CapabilityStatement_Document":{"type":"object","description":"A document definition.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"mode":{"x-fhir-type":"code","type":"string","enum":["producer","consumer"],"description":"producer | consumer"},"_mode":{"$ref":"#/components/schemas/Element"},"documentation":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Description of document support"},"_documentation":{"$ref":"#/components/schemas/Element"},"profile":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"Constraint on the resources used in the document"},"_profile":{"$ref":"#/components/schemas/Element"}},"required":["mode","profile"],"additionalProperties":false},"CapabilityStatement_Implementation":{"type":"object","description":"Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"description":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Describes this specific instance"},"_description":{"$ref":"#/components/schemas/Element"},"url":{"x-fhir-type":"url","type":"string","pattern":"^(\\S*)$","description":"Base URL for the installation"},"_url":{"$ref":"#/components/schemas/Element"},"custodian":{"$ref":"#/components/schemas/Reference","description":"Organization that manages the data"}},"required":["description"],"additionalProperties":false},"CapabilityStatement_Messaging":{"type":"object","description":"A description of the messaging capabilities of the solution.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"endpoint":{"type":"array","description":"Where messages should be sent","items":{"$ref":"#/components/schemas/CapabilityStatement_Messaging_Endpoint"}},"reliableCache":{"x-fhir-type":"unsignedInt","type":"integer","minimum":0,"description":"Reliable Message Cache Length (min)"},"_reliableCache":{"$ref":"#/components/schemas/Element"},"documentation":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Messaging interface behavior details"},"_documentation":{"$ref":"#/components/schemas/Element"},"supportedMessage":{"type":"array","description":"Messages supported by this system","items":{"$ref":"#/components/schemas/CapabilityStatement_Messaging_SupportedMessage"}}},"additionalProperties":false},"CapabilityStatement_Messaging_Endpoint":{"type":"object","description":"An endpoint (network accessible address) to which messages and/or replies are to be sent.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"protocol":{"$ref":"#/components/schemas/Coding","description":"http | ftp | mllp +"},"address":{"x-fhir-type":"url","type":"string","pattern":"^(\\S*)$","description":"Network address or identifier of the end-point"},"_address":{"$ref":"#/components/schemas/Element"}},"required":["protocol","address"],"additionalProperties":false},"CapabilityStatement_Messaging_SupportedMessage":{"type":"object","description":"References to message definitions for messages this system can send or receive.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"mode":{"x-fhir-type":"code","type":"string","enum":["sender","receiver"],"description":"sender | receiver"},"_mode":{"$ref":"#/components/schemas/Element"},"definition":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"Message supported by this system"},"_definition":{"$ref":"#/components/schemas/Element"}},"required":["mode","definition"],"additionalProperties":false},"CapabilityStatement_Rest":{"type":"object","description":"A definition of the restful capabilities of the solution, if any.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"mode":{"x-fhir-type":"code","type":"string","enum":["client","server"],"description":"client | server"},"_mode":{"$ref":"#/components/schemas/Element"},"documentation":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"General description of implementation"},"_documentation":{"$ref":"#/components/schemas/Element"},"security":{"$ref":"#/components/schemas/CapabilityStatement_Rest_Security","description":"Information about security of implementation"},"resource":{"type":"array","description":"Resource served on the REST interface","items":{"$ref":"#/components/schemas/CapabilityStatement_Rest_Resource"}},"interaction":{"type":"array","description":"What operations are supported?","items":{"$ref":"#/components/schemas/CapabilityStatement_Rest_Interaction"}},"searchParam":{"type":"array","description":"Search parameters for searching all resources","items":{"$ref":"#/components/schemas/CapabilityStatement_Rest_Resource_SearchParam"}},"operation":{"type":"array","description":"Definition of a system level operation","items":{"$ref":"#/components/schemas/CapabilityStatement_Rest_Resource_Operation"}},"compartment":{"type":"array","description":"Compartments served/used by system","items":{"anyOf":[{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$"},{"type":"null"}]}},"_compartment":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}}},"required":["mode"],"additionalProperties":false},"CapabilityStatement_Rest_Interaction":{"type":"object","description":"A specification of restful operations supported by the system.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","enum":["transaction","batch","search-system","history-system"],"description":"transaction | batch | search-system | history-system"},"_code":{"$ref":"#/components/schemas/Element"},"documentation":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Anything special about operation behavior"},"_documentation":{"$ref":"#/components/schemas/Element"}},"required":["code"],"additionalProperties":false},"CapabilityStatement_Rest_Resource":{"type":"object","description":"A specification of the restful capabilities of the solution for a specific resource type.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"type":{"x-fhir-type":"code","type":"string","enum":["Account","ActivityDefinition","ActorDefinition","AdministrableProductDefinition","AdverseEvent","AllergyIntolerance","Appointment","AppointmentResponse","ArtifactAssessment","AuditEvent","Basic","Binary","BiologicallyDerivedProduct","BiologicallyDerivedProductDispense","BodyStructure","Bundle","CapabilityStatement","CarePlan","CareTeam","ChargeItem","ChargeItemDefinition","Citation","Claim","ClaimResponse","ClinicalImpression","ClinicalUseDefinition","CodeSystem","Communication","CommunicationRequest","CompartmentDefinition","Composition","ConceptMap","Condition","ConditionDefinition","Consent","Contract","Coverage","CoverageEligibilityRequest","CoverageEligibilityResponse","DetectedIssue","Device","DeviceAssociation","DeviceDefinition","DeviceDispense","DeviceMetric","DeviceRequest","DeviceUsage","DiagnosticReport","DocumentReference","Encounter","EncounterHistory","Endpoint","EnrollmentRequest","EnrollmentResponse","EpisodeOfCare","EventDefinition","Evidence","EvidenceReport","EvidenceVariable","ExampleScenario","ExplanationOfBenefit","FamilyMemberHistory","Flag","FormularyItem","GenomicStudy","Goal","GraphDefinition","Group","GuidanceResponse","HealthcareService","ImagingSelection","ImagingStudy","Immunization","ImmunizationEvaluation","ImmunizationRecommendation","ImplementationGuide","Ingredient","InsurancePlan","InventoryItem","InventoryReport","Invoice","Library","Linkage","List","Location","ManufacturedItemDefinition","Measure","MeasureReport","Medication","MedicationAdministration","MedicationDispense","MedicationKnowledge","MedicationRequest","MedicationStatement","MedicinalProductDefinition","MessageDefinition","MessageHeader","MolecularSequence","NamingSystem","NutritionIntake","NutritionOrder","NutritionProduct","Observation","ObservationDefinition","OperationDefinition","OperationOutcome","Organization","OrganizationAffiliation","PackagedProductDefinition","Parameters","Patient","PaymentNotice","PaymentReconciliation","Permission","Person","PlanDefinition","Practitioner","PractitionerRole","Procedure","Provenance","Questionnaire","QuestionnaireResponse","RegulatedAuthorization","RelatedPerson","RequestOrchestration","Requirements","ResearchStudy","ResearchSubject","RiskAssessment","Schedule","SearchParameter","ServiceRequest","Slot","Specimen","SpecimenDefinition","StructureDefinition","StructureMap","Subscription","SubscriptionStatus","SubscriptionTopic","Substance","SubstanceDefinition","SubstanceNucleicAcid","SubstancePolymer","SubstanceProtein","SubstanceReferenceInformation","SubstanceSourceMaterial","SupplyDelivery","SupplyRequest","Task","TerminologyCapabilities","TestPlan","TestReport","TestScript","Transport","ValueSet","VerificationResult","VisionPrescription"],"description":"A resource type that is supported"},"_type":{"$ref":"#/components/schemas/Element"},"profile":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"System-wide profile"},"_profile":{"$ref":"#/components/schemas/Element"},"supportedProfile":{"type":"array","description":"Use-case specific profiles","items":{"anyOf":[{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$"},{"type":"null"}]}},"_supportedProfile":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"documentation":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Additional information about the use of the resource type"},"_documentation":{"$ref":"#/components/schemas/Element"},"interaction":{"type":"array","description":"What operations are supported?","items":{"$ref":"#/components/schemas/CapabilityStatement_Rest_Resource_Interaction"}},"versioning":{"x-fhir-type":"code","type":"string","enum":["no-version","versioned","versioned-update"],"description":"no-version | versioned | versioned-update"},"_versioning":{"$ref":"#/components/schemas/Element"},"readHistory":{"x-fhir-type":"boolean","type":"boolean","description":"Whether vRead can return past versions"},"_readHistory":{"$ref":"#/components/schemas/Element"},"updateCreate":{"x-fhir-type":"boolean","type":"boolean","description":"If update can commit to a new identity"},"_updateCreate":{"$ref":"#/components/schemas/Element"},"conditionalCreate":{"x-fhir-type":"boolean","type":"boolean","description":"If allows/uses conditional create"},"_conditionalCreate":{"$ref":"#/components/schemas/Element"},"conditionalRead":{"x-fhir-type":"code","type":"string","enum":["not-supported","modified-since","not-match","full-support"],"description":"not-supported | modified-since | not-match | full-support"},"_conditionalRead":{"$ref":"#/components/schemas/Element"},"conditionalUpdate":{"x-fhir-type":"boolean","type":"boolean","description":"If allows/uses conditional update"},"_conditionalUpdate":{"$ref":"#/components/schemas/Element"},"conditionalPatch":{"x-fhir-type":"boolean","type":"boolean","description":"If allows/uses conditional patch"},"_conditionalPatch":{"$ref":"#/components/schemas/Element"},"conditionalDelete":{"x-fhir-type":"code","type":"string","enum":["not-supported","single","multiple"],"description":"not-supported | single | multiple - how conditional delete is supported"},"_conditionalDelete":{"$ref":"#/components/schemas/Element"},"referencePolicy":{"type":"array","description":"literal | logical | resolves | enforced | local","items":{"anyOf":[{"x-fhir-type":"code","type":"string","enum":["literal","logical","resolves","enforced","local"]},{"type":"null"}]}},"_referencePolicy":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"searchInclude":{"type":"array","description":"_include values supported by the server","items":{"anyOf":[{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$"},{"type":"null"}]}},"_searchInclude":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"searchRevInclude":{"type":"array","description":"_revinclude values supported by the server","items":{"anyOf":[{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$"},{"type":"null"}]}},"_searchRevInclude":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"searchParam":{"type":"array","description":"Search parameters supported by implementation","items":{"$ref":"#/components/schemas/CapabilityStatement_Rest_Resource_SearchParam"}},"operation":{"type":"array","description":"Definition of a resource operation","items":{"$ref":"#/components/schemas/CapabilityStatement_Rest_Resource_Operation"}}},"required":["type"],"additionalProperties":false},"CapabilityStatement_Rest_Resource_Interaction":{"type":"object","description":"Identifies a restful operation supported by the solution.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","enum":["read","vread","update","patch","delete","history-instance","history-type","create","search-type"],"description":"read | vread | update | patch | delete | history-instance | history-type | create | search-type"},"_code":{"$ref":"#/components/schemas/Element"},"documentation":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Anything special about operation behavior"},"_documentation":{"$ref":"#/components/schemas/Element"}},"required":["code"],"additionalProperties":false},"CapabilityStatement_Rest_Resource_Operation":{"type":"object","description":"Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"name":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name by which the operation/query is invoked"},"_name":{"$ref":"#/components/schemas/Element"},"definition":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"The defined operation/query"},"_definition":{"$ref":"#/components/schemas/Element"},"documentation":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Specific details about operation behavior"},"_documentation":{"$ref":"#/components/schemas/Element"}},"required":["name","definition"],"additionalProperties":false},"CapabilityStatement_Rest_Resource_SearchParam":{"type":"object","description":"Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"name":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name for parameter in search url"},"_name":{"$ref":"#/components/schemas/Element"},"definition":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"Source of definition for parameter"},"_definition":{"$ref":"#/components/schemas/Element"},"type":{"x-fhir-type":"code","type":"string","enum":["number","date","string","token","reference","composite","quantity","uri","special"],"description":"number | date | string | token | reference | composite | quantity | uri | special"},"_type":{"$ref":"#/components/schemas/Element"},"documentation":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Server-specific usage"},"_documentation":{"$ref":"#/components/schemas/Element"}},"required":["name","type"],"additionalProperties":false},"CapabilityStatement_Rest_Security":{"type":"object","description":"Information about security implementation from an interface perspective - what a client needs to know.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"cors":{"x-fhir-type":"boolean","type":"boolean","description":"Adds CORS Headers (http://enable-cors.org/)"},"_cors":{"$ref":"#/components/schemas/Element"},"service":{"type":"array","description":"OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates","items":{"$ref":"#/components/schemas/CodeableConcept"}},"description":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"General description of how security works"},"_description":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"CapabilityStatement_Software":{"type":"object","description":"Software that is covered by this capability statement.  It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"name":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"A name the software is known by"},"_name":{"$ref":"#/components/schemas/Element"},"version":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Version covered by this statement"},"_version":{"$ref":"#/components/schemas/Element"},"releaseDate":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Date this version was released"},"_releaseDate":{"$ref":"#/components/schemas/Element"}},"required":["name"],"additionalProperties":false},"CodeSystem":{"type":"object","description":"The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.","properties":{"resourceType":{"const":"CodeSystem"},"id":{"type":"string","description":"Logical id of this artifact"},"meta":{"$ref":"#/components/schemas/Meta","description":"Metadata about the resource"},"implicitRules":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"A set of rules under which this content was created"},"_implicitRules":{"$ref":"#/components/schemas/Element"},"language":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Language of the resource content"},"_language":{"$ref":"#/components/schemas/Element"},"text":{"$ref":"#/components/schemas/Narrative","description":"Text summary of the resource, for human interpretation"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored","items":{"$ref":"#/components/schemas/Extension"}},"url":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)"},"_url":{"$ref":"#/components/schemas/Element"},"identifier":{"type":"array","description":"Additional identifier for the code system (business identifier)","items":{"$ref":"#/components/schemas/Identifier"}},"version":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Business version of the code system (Coding.version)"},"_version":{"$ref":"#/components/schemas/Element"},"versionAlgorithmString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"How to compare versions"},"_versionAlgorithmString":{"$ref":"#/components/schemas/Element"},"versionAlgorithmCoding":{"$ref":"#/components/schemas/Coding","description":"How to compare versions"},"name":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name for this code system (computer friendly)"},"_name":{"$ref":"#/components/schemas/Element"},"title":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name for this code system (human friendly)"},"_title":{"$ref":"#/components/schemas/Element"},"status":{"x-fhir-type":"code","type":"string","enum":["draft","active","retired","unknown"],"description":"draft | active | retired | unknown"},"_status":{"$ref":"#/components/schemas/Element"},"experimental":{"x-fhir-type":"boolean","type":"boolean","description":"For testing purposes, not real usage"},"_experimental":{"$ref":"#/components/schemas/Element"},"date":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Date last changed"},"_date":{"$ref":"#/components/schemas/Element"},"publisher":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name of the publisher/steward (organization or individual)"},"_publisher":{"$ref":"#/components/schemas/Element"},"contact":{"type":"array","description":"Contact details for the publisher","items":{"$ref":"#/components/schemas/ContactDetail"}},"description":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Natural language description of the code system"},"_description":{"$ref":"#/components/schemas/Element"},"useContext":{"type":"array","description":"The context that the content is intended to support","items":{"$ref":"#/components/schemas/UsageContext"}},"jurisdiction":{"type":"array","description":"Intended jurisdiction for code system (if applicable)","items":{"$ref":"#/components/schemas/CodeableConcept"}},"purpose":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Why this code system is defined"},"_purpose":{"$ref":"#/components/schemas/Element"},"copyright":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Use and/or publishing restrictions"},"_copyright":{"$ref":"#/components/schemas/Element"},"copyrightLabel":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Copyright holder and year(s)"},"_copyrightLabel":{"$ref":"#/components/schemas/Element"},"approvalDate":{"x-fhir-type":"date","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","description":"When the CodeSystem was approved by publisher"},"_approvalDate":{"$ref":"#/components/schemas/Element"},"lastReviewDate":{"x-fhir-type":"date","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","description":"When the CodeSystem was last reviewed by the publisher"},"_lastReviewDate":{"$ref":"#/components/schemas/Element"},"effectivePeriod":{"$ref":"#/components/schemas/Period","description":"When the CodeSystem is expected to be used"},"topic":{"type":"array","description":"E.g. Education, Treatment, Assessment, etc","items":{"$ref":"#/components/schemas/CodeableConcept"}},"author":{"type":"array","description":"Who authored the CodeSystem","items":{"$ref":"#/components/schemas/ContactDetail"}},"editor":{"type":"array","description":"Who edited the CodeSystem","items":{"$ref":"#/components/schemas/ContactDetail"}},"reviewer":{"type":"array","description":"Who reviewed the CodeSystem","items":{"$ref":"#/components/schemas/ContactDetail"}},"endorser":{"type":"array","description":"Who endorsed the CodeSystem","items":{"$ref":"#/components/schemas/ContactDetail"}},"relatedArtifact":{"type":"array","description":"Additional documentation, citations, etc","items":{"$ref":"#/components/schemas/RelatedArtifact"}},"caseSensitive":{"x-fhir-type":"boolean","type":"boolean","description":"If code comparison is case sensitive"},"_caseSensitive":{"$ref":"#/components/schemas/Element"},"valueSet":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"Canonical reference to the value set with entire code system"},"_valueSet":{"$ref":"#/components/schemas/Element"},"hierarchyMeaning":{"x-fhir-type":"code","type":"string","enum":["grouped-by","is-a","part-of","classified-with"],"description":"grouped-by | is-a | part-of | classified-with"},"_hierarchyMeaning":{"$ref":"#/components/schemas/Element"},"compositional":{"x-fhir-type":"boolean","type":"boolean","description":"If code system defines a compositional grammar"},"_compositional":{"$ref":"#/components/schemas/Element"},"versionNeeded":{"x-fhir-type":"boolean","type":"boolean","description":"If definitions are not stable"},"_versionNeeded":{"$ref":"#/components/schemas/Element"},"content":{"x-fhir-type":"code","type":"string","enum":["not-present","example","fragment","complete","supplement"],"description":"not-present | example | fragment | complete | supplement"},"_content":{"$ref":"#/components/schemas/Element"},"supplements":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"Canonical URL of Code System this adds designations and properties to"},"_supplements":{"$ref":"#/components/schemas/Element"},"count":{"x-fhir-type":"unsignedInt","type":"integer","minimum":0,"description":"Total concepts in the code system"},"_count":{"$ref":"#/components/schemas/Element"},"filter":{"type":"array","description":"Filter that can be used in a value set","items":{"$ref":"#/components/schemas/CodeSystem_Filter"}},"property":{"type":"array","description":"Additional information supplied about each concept","items":{"$ref":"#/components/schemas/CodeSystem_Property"}},"concept":{"type":"array","description":"Concepts in the code system","items":{"$ref":"#/components/schemas/CodeSystem_Concept"}}},"required":["resourceType","status","content"],"additionalProperties":false},"CodeSystem_Concept":{"type":"object","description":"Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Code that identifies concept"},"_code":{"$ref":"#/components/schemas/Element"},"display":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Text to display to the user"},"_display":{"$ref":"#/components/schemas/Element"},"definition":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Formal definition"},"_definition":{"$ref":"#/components/schemas/Element"},"designation":{"type":"array","description":"Additional representations for the concept","items":{"$ref":"#/components/schemas/CodeSystem_Concept_Designation"}},"property":{"type":"array","description":"Property value for the concept","items":{"$ref":"#/components/schemas/CodeSystem_Concept_Property"}},"concept":{"type":"array","description":"Child Concepts (is-a/contains/categorizes)","items":{"$ref":"#/components/schemas/CodeSystem_Concept"}}},"required":["code"],"additionalProperties":false},"CodeSystem_Concept_Designation":{"type":"object","description":"Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"language":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Human language of the designation"},"_language":{"$ref":"#/components/schemas/Element"},"use":{"$ref":"#/components/schemas/Coding","description":"Details how this designation would be used"},"additionalUse":{"type":"array","description":"Additional ways how this designation would be used","items":{"$ref":"#/components/schemas/Coding"}},"value":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"The text value for this designation"},"_value":{"$ref":"#/components/schemas/Element"}},"required":["value"],"additionalProperties":false},"CodeSystem_Concept_Property":{"type":"object","description":"A property value for this concept.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Reference to CodeSystem.property.code"},"_code":{"$ref":"#/components/schemas/Element"},"valueCode":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Value of the property for this concept"},"_valueCode":{"$ref":"#/components/schemas/Element"},"valueCoding":{"$ref":"#/components/schemas/Coding","description":"Value of the property for this concept"},"valueString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Value of the property for this concept"},"_valueString":{"$ref":"#/components/schemas/Element"},"valueInteger":{"x-fhir-type":"integer","type":"integer","description":"Value of the property for this concept"},"_valueInteger":{"$ref":"#/components/schemas/Element"},"valueBoolean":{"x-fhir-type":"boolean","type":"boolean","description":"Value of the property for this concept"},"_valueBoolean":{"$ref":"#/components/schemas/Element"},"valueDateTime":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Value of the property for this concept"},"_valueDateTime":{"$ref":"#/components/schemas/Element"},"valueDecimal":{"x-fhir-type":"decimal","type":"number","description":"Value of the property for this concept"},"_valueDecimal":{"$ref":"#/components/schemas/Element"}},"required":["code"],"additionalProperties":false},"CodeSystem_Filter":{"type":"object","description":"A filter that can be used in a value set compose statement when selecting concepts using a filter.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Code that identifies the filter"},"_code":{"$ref":"#/components/schemas/Element"},"description":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"How or why the filter is used"},"_description":{"$ref":"#/components/schemas/Element"},"operator":{"type":"array","description":"= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists","items":{"anyOf":[{"x-fhir-type":"code","type":"string","enum":["=","is-a","descendent-of","is-not-a","regex","in","not-in","generalizes","child-of","descendent-leaf","exists"]},{"type":"null"}]}},"_operator":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"value":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"What to use for the value"},"_value":{"$ref":"#/components/schemas/Element"}},"required":["code","operator","value"],"additionalProperties":false},"CodeSystem_Property":{"type":"object","description":"A property defines an additional slot through which additional information can be provided about a concept.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Identifies the property on the concepts, and when referred to in operations"},"_code":{"$ref":"#/components/schemas/Element"},"uri":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Formal identifier for the property"},"_uri":{"$ref":"#/components/schemas/Element"},"description":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Why the property is defined, and/or what it conveys"},"_description":{"$ref":"#/components/schemas/Element"},"type":{"x-fhir-type":"code","type":"string","enum":["code","Coding","string","integer","boolean","dateTime","decimal"],"description":"code | Coding | string | integer | boolean | dateTime | decimal"},"_type":{"$ref":"#/components/schemas/Element"}},"required":["code","type"],"additionalProperties":false},"CodeableConcept":{"type":"object","description":"CodeableConcept Type: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"coding":{"type":"array","description":"Code defined by a terminology system","items":{"$ref":"#/components/schemas/Coding"}},"text":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Plain text representation of the concept"},"_text":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"Coding":{"type":"object","description":"Coding Type: A reference to a code defined by a terminology system.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"system":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Identity of the terminology system"},"_system":{"$ref":"#/components/schemas/Element"},"version":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Version of the system - if relevant"},"_version":{"$ref":"#/components/schemas/Element"},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Symbol in syntax defined by the system"},"_code":{"$ref":"#/components/schemas/Element"},"display":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Representation defined by the system"},"_display":{"$ref":"#/components/schemas/Element"},"userSelected":{"x-fhir-type":"boolean","type":"boolean","description":"If this coding was chosen directly by the user"},"_userSelected":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"ConceptMap":{"type":"object","description":"A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.","properties":{"resourceType":{"const":"ConceptMap"},"id":{"type":"string","description":"Logical id of this artifact"},"meta":{"$ref":"#/components/schemas/Meta","description":"Metadata about the resource"},"implicitRules":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"A set of rules under which this content was created"},"_implicitRules":{"$ref":"#/components/schemas/Element"},"language":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Language of the resource content"},"_language":{"$ref":"#/components/schemas/Element"},"text":{"$ref":"#/components/schemas/Narrative","description":"Text summary of the resource, for human interpretation"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored","items":{"$ref":"#/components/schemas/Extension"}},"url":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Canonical identifier for this concept map, represented as a URI (globally unique)"},"_url":{"$ref":"#/components/schemas/Element"},"identifier":{"type":"array","description":"Additional identifier for the concept map","items":{"$ref":"#/components/schemas/Identifier"}},"version":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Business version of the concept map"},"_version":{"$ref":"#/components/schemas/Element"},"versionAlgorithmString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"How to compare versions"},"_versionAlgorithmString":{"$ref":"#/components/schemas/Element"},"versionAlgorithmCoding":{"$ref":"#/components/schemas/Coding","description":"How to compare versions"},"name":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name for this concept map (computer friendly)"},"_name":{"$ref":"#/components/schemas/Element"},"title":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name for this concept map (human friendly)"},"_title":{"$ref":"#/components/schemas/Element"},"status":{"x-fhir-type":"code","type":"string","enum":["draft","active","retired","unknown"],"description":"draft | active | retired | unknown"},"_status":{"$ref":"#/components/schemas/Element"},"experimental":{"x-fhir-type":"boolean","type":"boolean","description":"For testing purposes, not real usage"},"_experimental":{"$ref":"#/components/schemas/Element"},"date":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Date last changed"},"_date":{"$ref":"#/components/schemas/Element"},"publisher":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name of the publisher/steward (organization or individual)"},"_publisher":{"$ref":"#/components/schemas/Element"},"contact":{"type":"array","description":"Contact details for the publisher","items":{"$ref":"#/components/schemas/ContactDetail"}},"description":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Natural language description of the concept map"},"_description":{"$ref":"#/components/schemas/Element"},"useContext":{"type":"array","description":"The context that the content is intended to support","items":{"$ref":"#/components/schemas/UsageContext"}},"jurisdiction":{"type":"array","description":"Intended jurisdiction for concept map (if applicable)","items":{"$ref":"#/components/schemas/CodeableConcept"}},"purpose":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Why this concept map is defined"},"_purpose":{"$ref":"#/components/schemas/Element"},"copyright":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Use and/or publishing restrictions"},"_copyright":{"$ref":"#/components/schemas/Element"},"copyrightLabel":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Copyright holder and year(s)"},"_copyrightLabel":{"$ref":"#/components/schemas/Element"},"approvalDate":{"x-fhir-type":"date","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","description":"When the ConceptMap was approved by publisher"},"_approvalDate":{"$ref":"#/components/schemas/Element"},"lastReviewDate":{"x-fhir-type":"date","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","description":"When the ConceptMap was last reviewed by the publisher"},"_lastReviewDate":{"$ref":"#/components/schemas/Element"},"effectivePeriod":{"$ref":"#/components/schemas/Period","description":"When the ConceptMap is expected to be used"},"topic":{"type":"array","description":"E.g. Education, Treatment, Assessment, etc","items":{"$ref":"#/components/schemas/CodeableConcept"}},"author":{"type":"array","description":"Who authored the ConceptMap","items":{"$ref":"#/components/schemas/ContactDetail"}},"editor":{"type":"array","description":"Who edited the ConceptMap","items":{"$ref":"#/components/schemas/ContactDetail"}},"reviewer":{"type":"array","description":"Who reviewed the ConceptMap","items":{"$ref":"#/components/schemas/ContactDetail"}},"endorser":{"type":"array","description":"Who endorsed the ConceptMap","items":{"$ref":"#/components/schemas/ContactDetail"}},"relatedArtifact":{"type":"array","description":"Additional documentation, citations, etc","items":{"$ref":"#/components/schemas/RelatedArtifact"}},"property":{"type":"array","description":"Additional properties of the mapping","items":{"$ref":"#/components/schemas/ConceptMap_Property"}},"additionalAttribute":{"type":"array","description":"Definition of an additional attribute to act as a data source or target","items":{"$ref":"#/components/schemas/ConceptMap_AdditionalAttribute"}},"sourceScopeUri":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"The source value set that contains the concepts that are being mapped"},"_sourceScopeUri":{"$ref":"#/components/schemas/Element"},"sourceScopeCanonical":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"The source value set that contains the concepts that are being mapped"},"_sourceScopeCanonical":{"$ref":"#/components/schemas/Element"},"targetScopeUri":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"The target value set which provides context for the mappings"},"_targetScopeUri":{"$ref":"#/components/schemas/Element"},"targetScopeCanonical":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"The target value set which provides context for the mappings"},"_targetScopeCanonical":{"$ref":"#/components/schemas/Element"},"group":{"type":"array","description":"Same source and target systems","items":{"$ref":"#/components/schemas/ConceptMap_Group"}}},"required":["resourceType","status"],"additionalProperties":false},"ConceptMap_AdditionalAttribute":{"type":"object","description":"An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa).","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Identifies this additional attribute through this resource"},"_code":{"$ref":"#/components/schemas/Element"},"uri":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Formal identifier for the data element referred to in this attribte"},"_uri":{"$ref":"#/components/schemas/Element"},"description":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Why the additional attribute is defined, and/or what the data element it refers to is"},"_description":{"$ref":"#/components/schemas/Element"},"type":{"x-fhir-type":"code","type":"string","enum":["code","Coding","string","boolean","Quantity"],"description":"code | Coding | string | boolean | Quantity"},"_type":{"$ref":"#/components/schemas/Element"}},"required":["code","type"],"additionalProperties":false},"ConceptMap_Group":{"type":"object","description":"A group of mappings that all have the same source and target system.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"source":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"Source system where concepts to be mapped are defined"},"_source":{"$ref":"#/components/schemas/Element"},"target":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"Target system that the concepts are to be mapped to"},"_target":{"$ref":"#/components/schemas/Element"},"element":{"type":"array","description":"Mappings for a concept from the source set","items":{"$ref":"#/components/schemas/ConceptMap_Group_Element"}},"unmapped":{"$ref":"#/components/schemas/ConceptMap_Group_Unmapped","description":"What to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true"}},"required":["element"],"additionalProperties":false},"ConceptMap_Group_Element":{"type":"object","description":"Mappings for an individual concept in the source to one or more concepts in the target.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Identifies element being mapped"},"_code":{"$ref":"#/components/schemas/Element"},"display":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Display for the code"},"_display":{"$ref":"#/components/schemas/Element"},"valueSet":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"Identifies the set of concepts being mapped"},"_valueSet":{"$ref":"#/components/schemas/Element"},"noMap":{"x-fhir-type":"boolean","type":"boolean","description":"No mapping to a target concept for this source concept"},"_noMap":{"$ref":"#/components/schemas/Element"},"target":{"type":"array","description":"Concept in target system for element","items":{"$ref":"#/components/schemas/ConceptMap_Group_Element_Target"}}},"additionalProperties":false},"ConceptMap_Group_Element_Target":{"type":"object","description":"A concept from the target value set that this concept maps to.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Code that identifies the target element"},"_code":{"$ref":"#/components/schemas/Element"},"display":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Display for the code"},"_display":{"$ref":"#/components/schemas/Element"},"valueSet":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"Identifies the set of target concepts"},"_valueSet":{"$ref":"#/components/schemas/Element"},"relationship":{"x-fhir-type":"code","type":"string","enum":["related-to","equivalent","source-is-narrower-than-target","source-is-broader-than-target","not-related-to"],"description":"related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to"},"_relationship":{"$ref":"#/components/schemas/Element"},"comment":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Description of status/issues in mapping"},"_comment":{"$ref":"#/components/schemas/Element"},"property":{"type":"array","description":"Property value for the source -> target mapping","items":{"$ref":"#/components/schemas/ConceptMap_Group_Element_Target_Property"}},"dependsOn":{"type":"array","description":"Other properties required for this mapping","items":{"$ref":"#/components/schemas/ConceptMap_Group_Element_Target_DependsOn"}},"product":{"type":"array","description":"Other data elements that this mapping also produces","items":{"$ref":"#/components/schemas/ConceptMap_Group_Element_Target_DependsOn"}}},"required":["relationship"],"additionalProperties":false},"ConceptMap_Group_Element_Target_DependsOn":{"type":"object","description":"A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified value.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"attribute":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"A reference to a mapping attribute defined in ConceptMap.additionalAttribute"},"_attribute":{"$ref":"#/components/schemas/Element"},"valueCode":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Value of the referenced data element"},"_valueCode":{"$ref":"#/components/schemas/Element"},"valueCoding":{"$ref":"#/components/schemas/Coding","description":"Value of the referenced data element"},"valueString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Value of the referenced data element"},"_valueString":{"$ref":"#/components/schemas/Element"},"valueBoolean":{"x-fhir-type":"boolean","type":"boolean","description":"Value of the referenced data element"},"_valueBoolean":{"$ref":"#/components/schemas/Element"},"valueQuantity":{"$ref":"#/components/schemas/Quantity","description":"Value of the referenced data element"},"valueSet":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"The mapping depends on a data element with a value from this value set"},"_valueSet":{"$ref":"#/components/schemas/Element"}},"required":["attribute"],"additionalProperties":false},"ConceptMap_Group_Element_Target_Property":{"type":"object","description":"A property value for this source -> target mapping.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Reference to ConceptMap.property.code"},"_code":{"$ref":"#/components/schemas/Element"},"valueCoding":{"$ref":"#/components/schemas/Coding","description":"Value of the property for this concept"},"valueString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Value of the property for this concept"},"_valueString":{"$ref":"#/components/schemas/Element"},"valueInteger":{"x-fhir-type":"integer","type":"integer","description":"Value of the property for this concept"},"_valueInteger":{"$ref":"#/components/schemas/Element"},"valueBoolean":{"x-fhir-type":"boolean","type":"boolean","description":"Value of the property for this concept"},"_valueBoolean":{"$ref":"#/components/schemas/Element"},"valueDateTime":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Value of the property for this concept"},"_valueDateTime":{"$ref":"#/components/schemas/Element"},"valueDecimal":{"x-fhir-type":"decimal","type":"number","description":"Value of the property for this concept"},"_valueDecimal":{"$ref":"#/components/schemas/Element"},"valueCode":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Value of the property for this concept"},"_valueCode":{"$ref":"#/components/schemas/Element"}},"required":["code"],"additionalProperties":false},"ConceptMap_Group_Unmapped":{"type":"object","description":"What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the \"default\" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"mode":{"x-fhir-type":"code","type":"string","enum":["use-source-code","fixed","other-map"],"description":"use-source-code | fixed | other-map"},"_mode":{"$ref":"#/components/schemas/Element"},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Fixed code when mode = fixed"},"_code":{"$ref":"#/components/schemas/Element"},"display":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Display for the code"},"_display":{"$ref":"#/components/schemas/Element"},"valueSet":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"Fixed code set when mode = fixed"},"_valueSet":{"$ref":"#/components/schemas/Element"},"relationship":{"x-fhir-type":"code","type":"string","enum":["related-to","equivalent","source-is-narrower-than-target","source-is-broader-than-target","not-related-to"],"description":"related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to"},"_relationship":{"$ref":"#/components/schemas/Element"},"otherMap":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped"},"_otherMap":{"$ref":"#/components/schemas/Element"}},"required":["mode"],"additionalProperties":false},"ConceptMap_Property":{"type":"object","description":"A property defines a slot through which additional information can be provided about a map from source -> target.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Identifies the property on the mappings, and when referred to in the $translate operation"},"_code":{"$ref":"#/components/schemas/Element"},"uri":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Formal identifier for the property"},"_uri":{"$ref":"#/components/schemas/Element"},"description":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Why the property is defined, and/or what it conveys"},"_description":{"$ref":"#/components/schemas/Element"},"type":{"x-fhir-type":"code","type":"string","enum":["Coding","string","integer","boolean","dateTime","decimal","code"],"description":"Coding | string | integer | boolean | dateTime | decimal | code"},"_type":{"$ref":"#/components/schemas/Element"},"system":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"The CodeSystem from which code values come"},"_system":{"$ref":"#/components/schemas/Element"}},"required":["code","type"],"additionalProperties":false},"ContactDetail":{"type":"object","description":"ContactDetail Type: Specifies contact information for a person or organization.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"name":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name of an individual to contact"},"_name":{"$ref":"#/components/schemas/Element"},"telecom":{"type":"array","description":"Contact details for individual or organization","items":{"$ref":"#/components/schemas/ContactPoint"}}},"additionalProperties":false},"ContactPoint":{"type":"object","description":"ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"system":{"x-fhir-type":"code","type":"string","enum":["phone","fax","email","pager","url","sms","other"],"description":"phone | fax | email | pager | url | sms | other"},"_system":{"$ref":"#/components/schemas/Element"},"value":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"The actual contact point details"},"_value":{"$ref":"#/components/schemas/Element"},"use":{"x-fhir-type":"code","type":"string","enum":["home","work","temp","old","mobile"],"description":"home | work | temp | old | mobile - purpose of this contact point"},"_use":{"$ref":"#/components/schemas/Element"},"rank":{"x-fhir-type":"positiveInt","type":"integer","minimum":1,"description":"Specify preferred order of use (1 = highest)"},"_rank":{"$ref":"#/components/schemas/Element"},"period":{"$ref":"#/components/schemas/Period","description":"Time period when the contact point was/is in use"}},"additionalProperties":false},"Element":{"type":"object","description":"Element Type: Base definition for all elements in a resource.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}}},"additionalProperties":false},"Extension":{"type":"object","description":"Extension Type: Optional Extension Element - found in all resources.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"url":{"type":"string","description":"identifies the meaning of the extension"},"valueBoolean":{"x-fhir-type":"boolean","type":"boolean","description":"Value of extension"},"_valueBoolean":{"$ref":"#/components/schemas/Element"},"valueCanonical":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"Value of extension"},"_valueCanonical":{"$ref":"#/components/schemas/Element"},"valueCode":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Value of extension"},"_valueCode":{"$ref":"#/components/schemas/Element"},"valueDate":{"x-fhir-type":"date","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","description":"Value of extension"},"_valueDate":{"$ref":"#/components/schemas/Element"},"valueDateTime":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Value of extension"},"_valueDateTime":{"$ref":"#/components/schemas/Element"},"valueDecimal":{"x-fhir-type":"decimal","type":"number","description":"Value of extension"},"_valueDecimal":{"$ref":"#/components/schemas/Element"},"valueId":{"x-fhir-type":"id","type":"string","pattern":"^([A-Za-z0-9\\-\\.]{1,64})$","description":"Value of extension"},"_valueId":{"$ref":"#/components/schemas/Element"},"valueInstant":{"x-fhir-type":"instant","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))$","description":"Value of extension"},"_valueInstant":{"$ref":"#/components/schemas/Element"},"valueInteger":{"x-fhir-type":"integer","type":"integer","description":"Value of extension"},"_valueInteger":{"$ref":"#/components/schemas/Element"},"valueInteger64":{"x-fhir-type":"integer64","type":"string","pattern":"^([0]|[-+]?[1-9][0-9]*)$","description":"Value of extension"},"_valueInteger64":{"$ref":"#/components/schemas/Element"},"valueMarkdown":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Value of extension"},"_valueMarkdown":{"$ref":"#/components/schemas/Element"},"valueOid":{"x-fhir-type":"oid","type":"string","pattern":"^(urn:oid:[0-2](\\.(0|[1-9][0-9]*))+)$","description":"Value of extension"},"_valueOid":{"$ref":"#/components/schemas/Element"},"valuePositiveInt":{"x-fhir-type":"positiveInt","type":"integer","minimum":1,"description":"Value of extension"},"_valuePositiveInt":{"$ref":"#/components/schemas/Element"},"valueString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Value of extension"},"_valueString":{"$ref":"#/components/schemas/Element"},"valueTime":{"x-fhir-type":"time","type":"string","pattern":"^(([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)$","description":"Value of extension"},"_valueTime":{"$ref":"#/components/schemas/Element"},"valueUnsignedInt":{"x-fhir-type":"unsignedInt","type":"integer","minimum":0,"description":"Value of extension"},"_valueUnsignedInt":{"$ref":"#/components/schemas/Element"},"valueUri":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Value of extension"},"_valueUri":{"$ref":"#/components/schemas/Element"},"valueUrl":{"x-fhir-type":"url","type":"string","pattern":"^(\\S*)$","description":"Value of extension"},"_valueUrl":{"$ref":"#/components/schemas/Element"},"valueUuid":{"x-fhir-type":"uuid","type":"string","pattern":"^(urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","description":"Value of extension"},"_valueUuid":{"$ref":"#/components/schemas/Element"},"valueCodeableConcept":{"$ref":"#/components/schemas/CodeableConcept","description":"Value of extension"},"valueCoding":{"$ref":"#/components/schemas/Coding","description":"Value of extension"}},"required":["url"],"additionalProperties":false},"Identifier":{"type":"object","description":"Identifier Type: An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"use":{"x-fhir-type":"code","type":"string","enum":["usual","official","temp","secondary","old"],"description":"usual | official | temp | secondary | old (If known)"},"_use":{"$ref":"#/components/schemas/Element"},"type":{"$ref":"#/components/schemas/CodeableConcept","description":"Description of identifier"},"system":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"The namespace for the identifier value"},"_system":{"$ref":"#/components/schemas/Element"},"value":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"The value that is unique"},"_value":{"$ref":"#/components/schemas/Element"},"period":{"$ref":"#/components/schemas/Period","description":"Time period when id is/was valid for use"},"assigner":{"$ref":"#/components/schemas/Reference","description":"Organization that issued id (may be just text)"}},"additionalProperties":false},"Meta":{"type":"object","description":"Meta Type: The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"versionId":{"x-fhir-type":"id","type":"string","pattern":"^([A-Za-z0-9\\-\\.]{1,64})$","description":"Version specific identifier"},"_versionId":{"$ref":"#/components/schemas/Element"},"lastUpdated":{"x-fhir-type":"instant","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))$","description":"When the resource version last changed"},"_lastUpdated":{"$ref":"#/components/schemas/Element"},"source":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Identifies where the resource comes from"},"_source":{"$ref":"#/components/schemas/Element"},"profile":{"type":"array","description":"Profiles this resource claims to conform to","items":{"anyOf":[{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$"},{"type":"null"}]}},"_profile":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"security":{"type":"array","description":"Security Labels applied to this resource","items":{"$ref":"#/components/schemas/Coding"}},"tag":{"type":"array","description":"Tags applied to this resource","items":{"$ref":"#/components/schemas/Coding"}}},"additionalProperties":false},"Narrative":{"type":"object","description":"Narrative Type: A human-readable summary of the resource conveying the essential clinical and business information for the resource.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"status":{"x-fhir-type":"code","type":"string","enum":["generated","extensions","additional","empty"],"description":"generated | extensions | additional | empty"},"_status":{"$ref":"#/components/schemas/Element"},"div":{"x-fhir-type":"xhtml","type":"string","description":"Limited xhtml content"},"_div":{"$ref":"#/components/schemas/Element"}},"required":["status","div"],"additionalProperties":false},"OperationOutcome":{"type":"object","description":"A collection of error, warning, or information messages that result from a system action.","properties":{"resourceType":{"const":"OperationOutcome"},"id":{"type":"string","description":"Logical id of this artifact"},"meta":{"$ref":"#/components/schemas/Meta","description":"Metadata about the resource"},"implicitRules":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"A set of rules under which this content was created"},"_implicitRules":{"$ref":"#/components/schemas/Element"},"language":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Language of the resource content"},"_language":{"$ref":"#/components/schemas/Element"},"text":{"$ref":"#/components/schemas/Narrative","description":"Text summary of the resource, for human interpretation"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored","items":{"$ref":"#/components/schemas/Extension"}},"issue":{"type":"array","description":"A single issue associated with the action","items":{"$ref":"#/components/schemas/OperationOutcome_Issue"}}},"required":["resourceType","issue"],"additionalProperties":false},"OperationOutcome_Issue":{"type":"object","description":"An error, warning, or information message that results from a system action.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"severity":{"x-fhir-type":"code","type":"string","enum":["fatal","error","warning","information","success"],"description":"fatal | error | warning | information | success"},"_severity":{"$ref":"#/components/schemas/Element"},"code":{"x-fhir-type":"code","type":"string","enum":["invalid","structure","required","value","invariant","security","login","unknown","expired","forbidden","suppressed","processing","not-supported","duplicate","multiple-matches","not-found","deleted","too-long","code-invalid","extension","too-costly","business-rule","conflict","limited-filter","transient","lock-error","no-store","exception","timeout","incomplete","throttled","informational","success"],"description":"Error or warning code"},"_code":{"$ref":"#/components/schemas/Element"},"details":{"description":"What the issue is: details.text, and (except for information) a tx-issue-type coding (http://hl7.org/fhir/tools/CodeSystem/tx-issue-type)","allOf":[{"$ref":"#/components/schemas/CodeableConcept"},{"required":["text"]}]},"diagnostics":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Additional diagnostic information about the issue"},"_diagnostics":{"$ref":"#/components/schemas/Element"},"location":{"type":"array","description":"Deprecated: Path of element(s) related to issue","items":{"anyOf":[{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$"},{"type":"null"}]}},"_location":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"expression":{"type":"array","description":"FHIRPath of element(s) related to issue","items":{"anyOf":[{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$"},{"type":"null"}]}},"_expression":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}}},"required":["severity","code","details"],"additionalProperties":false,"if":{"properties":{"severity":{"const":"information"}}},"else":{"properties":{"details":{"required":["coding"],"properties":{"coding":{"contains":{"type":"object","properties":{"system":{"const":"http://hl7.org/fhir/tools/CodeSystem/tx-issue-type"}},"required":["system","code"]}}}}}}},"Parameters":{"type":"object","description":"Operation parameters, in or out. Each operation lists the parameters it uses. A parameter's value is a primitive, a Coding or a CodeableConcept; its resource is a CodeSystem, ValueSet, ConceptMap or OperationOutcome, or a Parameters - which only a `validation` in $batch-validate-code (and its result), and a `profile` (an expansion profile), hold.","properties":{"resourceType":{"const":"Parameters"},"id":{"type":"string","description":"Logical id of this artifact"},"meta":{"$ref":"#/components/schemas/Meta","description":"Metadata about the resource"},"implicitRules":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"A set of rules under which this content was created"},"_implicitRules":{"$ref":"#/components/schemas/Element"},"language":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Language of the resource content"},"_language":{"$ref":"#/components/schemas/Element"},"parameter":{"type":"array","description":"Operation Parameter","items":{"$ref":"#/components/schemas/Parameters_Parameter"}}},"required":["resourceType"],"additionalProperties":false},"Parameters_Parameter":{"type":"object","description":"A parameter passed to or received from the operation.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"name":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name from the definition"},"_name":{"$ref":"#/components/schemas/Element"},"valueBoolean":{"x-fhir-type":"boolean","type":"boolean","description":"If parameter is a data type"},"_valueBoolean":{"$ref":"#/components/schemas/Element"},"valueCanonical":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"If parameter is a data type"},"_valueCanonical":{"$ref":"#/components/schemas/Element"},"valueCode":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"If parameter is a data type"},"_valueCode":{"$ref":"#/components/schemas/Element"},"valueDate":{"x-fhir-type":"date","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","description":"If parameter is a data type"},"_valueDate":{"$ref":"#/components/schemas/Element"},"valueDateTime":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"If parameter is a data type"},"_valueDateTime":{"$ref":"#/components/schemas/Element"},"valueDecimal":{"x-fhir-type":"decimal","type":"number","description":"If parameter is a data type"},"_valueDecimal":{"$ref":"#/components/schemas/Element"},"valueId":{"x-fhir-type":"id","type":"string","pattern":"^([A-Za-z0-9\\-\\.]{1,64})$","description":"If parameter is a data type"},"_valueId":{"$ref":"#/components/schemas/Element"},"valueInstant":{"x-fhir-type":"instant","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))$","description":"If parameter is a data type"},"_valueInstant":{"$ref":"#/components/schemas/Element"},"valueInteger":{"x-fhir-type":"integer","type":"integer","description":"If parameter is a data type"},"_valueInteger":{"$ref":"#/components/schemas/Element"},"valueInteger64":{"x-fhir-type":"integer64","type":"string","pattern":"^([0]|[-+]?[1-9][0-9]*)$","description":"If parameter is a data type"},"_valueInteger64":{"$ref":"#/components/schemas/Element"},"valueMarkdown":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"If parameter is a data type"},"_valueMarkdown":{"$ref":"#/components/schemas/Element"},"valueOid":{"x-fhir-type":"oid","type":"string","pattern":"^(urn:oid:[0-2](\\.(0|[1-9][0-9]*))+)$","description":"If parameter is a data type"},"_valueOid":{"$ref":"#/components/schemas/Element"},"valuePositiveInt":{"x-fhir-type":"positiveInt","type":"integer","minimum":1,"description":"If parameter is a data type"},"_valuePositiveInt":{"$ref":"#/components/schemas/Element"},"valueString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"If parameter is a data type"},"_valueString":{"$ref":"#/components/schemas/Element"},"valueTime":{"x-fhir-type":"time","type":"string","pattern":"^(([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)$","description":"If parameter is a data type"},"_valueTime":{"$ref":"#/components/schemas/Element"},"valueUnsignedInt":{"x-fhir-type":"unsignedInt","type":"integer","minimum":0,"description":"If parameter is a data type"},"_valueUnsignedInt":{"$ref":"#/components/schemas/Element"},"valueUri":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"If parameter is a data type"},"_valueUri":{"$ref":"#/components/schemas/Element"},"valueUrl":{"x-fhir-type":"url","type":"string","pattern":"^(\\S*)$","description":"If parameter is a data type"},"_valueUrl":{"$ref":"#/components/schemas/Element"},"valueUuid":{"x-fhir-type":"uuid","type":"string","pattern":"^(urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","description":"If parameter is a data type"},"_valueUuid":{"$ref":"#/components/schemas/Element"},"valueCodeableConcept":{"$ref":"#/components/schemas/CodeableConcept","description":"If parameter is a data type"},"valueCoding":{"$ref":"#/components/schemas/Coding","description":"If parameter is a data type"},"resource":{"anyOf":[{"$ref":"#/components/schemas/CodeSystem"},{"$ref":"#/components/schemas/ValueSet"},{"$ref":"#/components/schemas/ConceptMap"},{"$ref":"#/components/schemas/OperationOutcome"},{"$ref":"#/components/schemas/Parameters"}],"description":"If parameter is a whole resource"},"part":{"type":"array","description":"Named part of a multi-part parameter","items":{"$ref":"#/components/schemas/Parameters_Parameter"}}},"required":["name"],"additionalProperties":false},"Period":{"type":"object","description":"Period Type: A time period defined by a start and end date and optionally time.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"start":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Starting time with inclusive boundary"},"_start":{"$ref":"#/components/schemas/Element"},"end":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"End time with inclusive boundary, if not ongoing"},"_end":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"Quantity":{"type":"object","description":"Quantity Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"value":{"x-fhir-type":"decimal","type":"number","description":"Numerical value (with implicit precision)"},"_value":{"$ref":"#/components/schemas/Element"},"comparator":{"x-fhir-type":"code","type":"string","enum":["<","<=",">=",">","ad"],"description":"< | <= | >= | > | ad - how to understand the value"},"_comparator":{"$ref":"#/components/schemas/Element"},"unit":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Unit representation"},"_unit":{"$ref":"#/components/schemas/Element"},"system":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"System that defines coded unit form"},"_system":{"$ref":"#/components/schemas/Element"},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Coded form of the unit"},"_code":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"Range":{"type":"object","description":"Range Type: A set of ordered Quantities defined by a low and high limit.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"low":{"$ref":"#/components/schemas/Quantity","description":"Low limit"},"high":{"$ref":"#/components/schemas/Quantity","description":"High limit"}},"additionalProperties":false},"Reference":{"type":"object","description":"Reference Type: A reference from one resource to another.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"reference":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Literal reference, Relative, internal or absolute URL"},"_reference":{"$ref":"#/components/schemas/Element"},"type":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Type the reference refers to (e.g. \"Patient\") - must be a resource in resources"},"_type":{"$ref":"#/components/schemas/Element"},"identifier":{"$ref":"#/components/schemas/Identifier","description":"Logical reference, when literal reference is not known"},"display":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Text alternative for the resource"},"_display":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"RelatedArtifact":{"type":"object","description":"RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"type":{"x-fhir-type":"code","type":"string","enum":["documentation","justification","citation","predecessor","successor","derived-from","depends-on","composed-of","part-of","amends","amended-with","appends","appended-with","cites","cited-by","comments-on","comment-in","contains","contained-in","corrects","correction-in","replaces","replaced-with","retracts","retracted-by","signs","similar-to","supports","supported-with","transforms","transformed-into","transformed-with","documents","specification-of","created-with","cite-as"],"description":"documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as"},"_type":{"$ref":"#/components/schemas/Element"},"classifier":{"type":"array","description":"Additional classifiers","items":{"$ref":"#/components/schemas/CodeableConcept"}},"label":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Short label"},"_label":{"$ref":"#/components/schemas/Element"},"display":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Brief description of the related artifact"},"_display":{"$ref":"#/components/schemas/Element"},"citation":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Bibliographic citation for the artifact"},"_citation":{"$ref":"#/components/schemas/Element"},"document":{"$ref":"#/components/schemas/Attachment","description":"What document is being referenced"},"resource":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"What artifact is being referenced"},"_resource":{"$ref":"#/components/schemas/Element"},"resourceReference":{"$ref":"#/components/schemas/Reference","description":"What artifact, if not a conformance resource"},"publicationStatus":{"x-fhir-type":"code","type":"string","enum":["draft","active","retired","unknown"],"description":"draft | active | retired | unknown"},"_publicationStatus":{"$ref":"#/components/schemas/Element"},"publicationDate":{"x-fhir-type":"date","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","description":"Date of publication of the artifact being referred to"},"_publicationDate":{"$ref":"#/components/schemas/Element"}},"required":["type"],"additionalProperties":false},"Signature":{"type":"object","description":"Signature Type: A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"type":{"type":"array","description":"Indication of the reason the entity signed the object(s)","items":{"$ref":"#/components/schemas/Coding"}},"when":{"x-fhir-type":"instant","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))$","description":"When the signature was created"},"_when":{"$ref":"#/components/schemas/Element"},"who":{"$ref":"#/components/schemas/Reference","description":"Who signed"},"onBehalfOf":{"$ref":"#/components/schemas/Reference","description":"The party represented"},"targetFormat":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"The technical format of the signed resources"},"_targetFormat":{"$ref":"#/components/schemas/Element"},"sigFormat":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"The technical format of the signature"},"_sigFormat":{"$ref":"#/components/schemas/Element"},"data":{"x-fhir-type":"base64Binary","type":"string","pattern":"^((?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?)$","description":"The actual signature content (XML DigSig. JWS, picture, etc.)"},"_data":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"TerminologyCapabilities":{"type":"object","description":"A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.","properties":{"resourceType":{"const":"TerminologyCapabilities"},"id":{"type":"string","description":"Logical id of this artifact"},"meta":{"$ref":"#/components/schemas/Meta","description":"Metadata about the resource"},"implicitRules":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"A set of rules under which this content was created"},"_implicitRules":{"$ref":"#/components/schemas/Element"},"language":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Language of the resource content"},"_language":{"$ref":"#/components/schemas/Element"},"text":{"$ref":"#/components/schemas/Narrative","description":"Text summary of the resource, for human interpretation"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored","items":{"$ref":"#/components/schemas/Extension"}},"url":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Canonical identifier for this terminology capabilities, represented as a URI (globally unique)"},"_url":{"$ref":"#/components/schemas/Element"},"identifier":{"type":"array","description":"Additional identifier for the terminology capabilities","items":{"$ref":"#/components/schemas/Identifier"}},"version":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Business version of the terminology capabilities"},"_version":{"$ref":"#/components/schemas/Element"},"versionAlgorithmString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"How to compare versions"},"_versionAlgorithmString":{"$ref":"#/components/schemas/Element"},"versionAlgorithmCoding":{"$ref":"#/components/schemas/Coding","description":"How to compare versions"},"name":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name for this terminology capabilities (computer friendly)"},"_name":{"$ref":"#/components/schemas/Element"},"title":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name for this terminology capabilities (human friendly)"},"_title":{"$ref":"#/components/schemas/Element"},"status":{"x-fhir-type":"code","type":"string","enum":["draft","active","retired","unknown"],"description":"draft | active | retired | unknown"},"_status":{"$ref":"#/components/schemas/Element"},"experimental":{"x-fhir-type":"boolean","type":"boolean","description":"For testing purposes, not real usage"},"_experimental":{"$ref":"#/components/schemas/Element"},"date":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Date last changed"},"_date":{"$ref":"#/components/schemas/Element"},"publisher":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name of the publisher/steward (organization or individual)"},"_publisher":{"$ref":"#/components/schemas/Element"},"contact":{"type":"array","description":"Contact details for the publisher","items":{"$ref":"#/components/schemas/ContactDetail"}},"description":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Natural language description of the terminology capabilities"},"_description":{"$ref":"#/components/schemas/Element"},"useContext":{"type":"array","description":"The context that the content is intended to support","items":{"$ref":"#/components/schemas/UsageContext"}},"jurisdiction":{"type":"array","description":"Intended jurisdiction for terminology capabilities (if applicable)","items":{"$ref":"#/components/schemas/CodeableConcept"}},"purpose":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Why this terminology capabilities is defined"},"_purpose":{"$ref":"#/components/schemas/Element"},"copyright":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Use and/or publishing restrictions"},"_copyright":{"$ref":"#/components/schemas/Element"},"copyrightLabel":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Copyright holder and year(s)"},"_copyrightLabel":{"$ref":"#/components/schemas/Element"},"kind":{"x-fhir-type":"code","type":"string","enum":["instance","capability","requirements"],"description":"instance | capability | requirements"},"_kind":{"$ref":"#/components/schemas/Element"},"software":{"$ref":"#/components/schemas/TerminologyCapabilities_Software","description":"Software that is covered by this terminology capability statement"},"implementation":{"$ref":"#/components/schemas/TerminologyCapabilities_Implementation","description":"If this describes a specific instance"},"lockedDate":{"x-fhir-type":"boolean","type":"boolean","description":"Whether lockedDate is supported"},"_lockedDate":{"$ref":"#/components/schemas/Element"},"codeSystem":{"type":"array","description":"A code system supported by the server","items":{"$ref":"#/components/schemas/TerminologyCapabilities_CodeSystem"}},"expansion":{"$ref":"#/components/schemas/TerminologyCapabilities_Expansion","description":"Information about the [ValueSet/$expand](valueset-operation-expand.html) operation"},"codeSearch":{"x-fhir-type":"code","type":"string","enum":["in-compose","in-expansion","in-compose-or-expansion"],"description":"in-compose | in-expansion | in-compose-or-expansion"},"_codeSearch":{"$ref":"#/components/schemas/Element"},"validateCode":{"$ref":"#/components/schemas/TerminologyCapabilities_ValidateCode","description":"Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation"},"translation":{"$ref":"#/components/schemas/TerminologyCapabilities_Translation","description":"Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation"},"closure":{"$ref":"#/components/schemas/TerminologyCapabilities_Closure","description":"Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation"}},"required":["resourceType","status","date","kind"],"additionalProperties":false},"TerminologyCapabilities_Closure":{"type":"object","description":"Whether the $closure operation is supported.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"translation":{"x-fhir-type":"boolean","type":"boolean","description":"If cross-system closure is supported"},"_translation":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"TerminologyCapabilities_CodeSystem":{"type":"object","description":"Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"uri":{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$","description":"Canonical identifier for the code system, represented as a URI"},"_uri":{"$ref":"#/components/schemas/Element"},"version":{"type":"array","description":"Version of Code System supported","items":{"$ref":"#/components/schemas/TerminologyCapabilities_CodeSystem_Version"}},"content":{"x-fhir-type":"code","type":"string","enum":["not-present","example","fragment","complete","supplement"],"description":"not-present | example | fragment | complete | supplement"},"_content":{"$ref":"#/components/schemas/Element"},"subsumption":{"x-fhir-type":"boolean","type":"boolean","description":"Whether subsumption is supported"},"_subsumption":{"$ref":"#/components/schemas/Element"}},"required":["content"],"additionalProperties":false},"TerminologyCapabilities_CodeSystem_Version":{"type":"object","description":"For the code system, a list of versions that are supported by the server.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Version identifier for this version"},"_code":{"$ref":"#/components/schemas/Element"},"isDefault":{"x-fhir-type":"boolean","type":"boolean","description":"If this is the default version for this code system"},"_isDefault":{"$ref":"#/components/schemas/Element"},"compositional":{"x-fhir-type":"boolean","type":"boolean","description":"If compositional grammar is supported"},"_compositional":{"$ref":"#/components/schemas/Element"},"language":{"type":"array","description":"Language Displays supported","items":{"anyOf":[{"x-fhir-type":"code","type":"string","enum":["ar","bg","bg-BG","bn","cs","cs-CZ","bs","bs-BA","da","da-DK","de","de-AT","de-CH","de-DE","el","el-GR","en","en-AU","en-CA","en-GB","en-IN","en-NZ","en-SG","en-US","es","es-AR","es-ES","es-UY","et","et-EE","fi","fr","fr-BE","fr-CH","fr-FR","fi-FI","fr-CA","fy","fy-NL","hi","hr","hr-HR","is","is-IS","it","it-CH","it-IT","ja","ko","lt","lt-LT","lv","lv-LV","nl","nl-BE","nl-NL","no","no-NO","pa","pl","pl-PL","pt","pt-PT","pt-BR","ro","ro-RO","ru","ru-RU","sk","sk-SK","sl","sl-SI","sr","sr-RS","sv","sv-SE","te","zh","zh-CN","zh-HK","zh-SG","zh-TW"]},{"type":"null"}]}},"_language":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"filter":{"type":"array","description":"Filter Properties supported","items":{"$ref":"#/components/schemas/TerminologyCapabilities_CodeSystem_Version_Filter"}},"property":{"type":"array","description":"Properties supported for $lookup","items":{"anyOf":[{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$"},{"type":"null"}]}},"_property":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}}},"additionalProperties":false},"TerminologyCapabilities_CodeSystem_Version_Filter":{"type":"object","description":"Filter Properties supported.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Code of the property supported"},"_code":{"$ref":"#/components/schemas/Element"},"op":{"type":"array","description":"Operations supported for the property","items":{"anyOf":[{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$"},{"type":"null"}]}},"_op":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}}},"required":["code","op"],"additionalProperties":false},"TerminologyCapabilities_Expansion":{"type":"object","description":"Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"hierarchical":{"x-fhir-type":"boolean","type":"boolean","description":"Whether the server can return nested value sets"},"_hierarchical":{"$ref":"#/components/schemas/Element"},"paging":{"x-fhir-type":"boolean","type":"boolean","description":"Whether the server supports paging on expansion"},"_paging":{"$ref":"#/components/schemas/Element"},"incomplete":{"x-fhir-type":"boolean","type":"boolean","description":"Allow request for incomplete expansions?"},"_incomplete":{"$ref":"#/components/schemas/Element"},"parameter":{"type":"array","description":"Supported expansion parameter","items":{"$ref":"#/components/schemas/TerminologyCapabilities_Expansion_Parameter"}},"textFilter":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Documentation about text searching works"},"_textFilter":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"TerminologyCapabilities_Expansion_Parameter":{"type":"object","description":"Supported expansion parameter.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"name":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Name of the supported expansion parameter"},"_name":{"$ref":"#/components/schemas/Element"},"documentation":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Description of support for parameter"},"_documentation":{"$ref":"#/components/schemas/Element"}},"required":["name"],"additionalProperties":false},"TerminologyCapabilities_Implementation":{"type":"object","description":"Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"description":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Describes this specific instance"},"_description":{"$ref":"#/components/schemas/Element"},"url":{"x-fhir-type":"url","type":"string","pattern":"^(\\S*)$","description":"Base URL for the implementation"},"_url":{"$ref":"#/components/schemas/Element"}},"required":["description"],"additionalProperties":false},"TerminologyCapabilities_Software":{"type":"object","description":"Software that is covered by this terminology capability statement.  It is used when the statement describes the capabilities of a particular software version, independent of an installation.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"name":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"A name the software is known by"},"_name":{"$ref":"#/components/schemas/Element"},"version":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Version covered by this statement"},"_version":{"$ref":"#/components/schemas/Element"}},"required":["name"],"additionalProperties":false},"TerminologyCapabilities_Translation":{"type":"object","description":"Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"needsMap":{"x-fhir-type":"boolean","type":"boolean","description":"Whether the client must identify the map"},"_needsMap":{"$ref":"#/components/schemas/Element"}},"required":["needsMap"],"additionalProperties":false},"TerminologyCapabilities_ValidateCode":{"type":"object","description":"Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"translations":{"x-fhir-type":"boolean","type":"boolean","description":"Whether translations are validated"},"_translations":{"$ref":"#/components/schemas/Element"}},"required":["translations"],"additionalProperties":false},"UsageContext":{"type":"object","description":"UsageContext Type: Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"code":{"$ref":"#/components/schemas/Coding","description":"Type of context being specified"},"valueCodeableConcept":{"$ref":"#/components/schemas/CodeableConcept","description":"Value that defines the context"},"valueQuantity":{"$ref":"#/components/schemas/Quantity","description":"Value that defines the context"},"valueRange":{"$ref":"#/components/schemas/Range","description":"Value that defines the context"},"valueReference":{"$ref":"#/components/schemas/Reference","description":"Value that defines the context"}},"required":["code"],"additionalProperties":false},"ValueSet":{"type":"object","description":"A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).","properties":{"resourceType":{"const":"ValueSet"},"id":{"type":"string","description":"Logical id of this artifact"},"meta":{"$ref":"#/components/schemas/Meta","description":"Metadata about the resource"},"implicitRules":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"A set of rules under which this content was created"},"_implicitRules":{"$ref":"#/components/schemas/Element"},"language":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Language of the resource content"},"_language":{"$ref":"#/components/schemas/Element"},"text":{"$ref":"#/components/schemas/Narrative","description":"Text summary of the resource, for human interpretation"},"contained":{"type":"array","description":"Contained value sets, which the value set includes or excludes by reference (#id). Only value sets can be contained, and they can't contain resources themselves","items":{"$ref":"#/components/schemas/ValueSet"}},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored","items":{"$ref":"#/components/schemas/Extension"}},"url":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Canonical identifier for this value set, represented as a URI (globally unique)"},"_url":{"$ref":"#/components/schemas/Element"},"identifier":{"type":"array","description":"Additional identifier for the value set (business identifier)","items":{"$ref":"#/components/schemas/Identifier"}},"version":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Business version of the value set"},"_version":{"$ref":"#/components/schemas/Element"},"versionAlgorithmString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"How to compare versions"},"_versionAlgorithmString":{"$ref":"#/components/schemas/Element"},"versionAlgorithmCoding":{"$ref":"#/components/schemas/Coding","description":"How to compare versions"},"name":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name for this value set (computer friendly)"},"_name":{"$ref":"#/components/schemas/Element"},"title":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name for this value set (human friendly)"},"_title":{"$ref":"#/components/schemas/Element"},"status":{"x-fhir-type":"code","type":"string","enum":["draft","active","retired","unknown"],"description":"draft | active | retired | unknown"},"_status":{"$ref":"#/components/schemas/Element"},"experimental":{"x-fhir-type":"boolean","type":"boolean","description":"For testing purposes, not real usage"},"_experimental":{"$ref":"#/components/schemas/Element"},"date":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Date last changed"},"_date":{"$ref":"#/components/schemas/Element"},"publisher":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name of the publisher/steward (organization or individual)"},"_publisher":{"$ref":"#/components/schemas/Element"},"contact":{"type":"array","description":"Contact details for the publisher","items":{"$ref":"#/components/schemas/ContactDetail"}},"description":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Natural language description of the value set"},"_description":{"$ref":"#/components/schemas/Element"},"useContext":{"type":"array","description":"The context that the content is intended to support","items":{"$ref":"#/components/schemas/UsageContext"}},"jurisdiction":{"type":"array","description":"Intended jurisdiction for value set (if applicable)","items":{"$ref":"#/components/schemas/CodeableConcept"}},"immutable":{"x-fhir-type":"boolean","type":"boolean","description":"Indicates whether or not any change to the content logical definition may occur"},"_immutable":{"$ref":"#/components/schemas/Element"},"purpose":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Why this value set is defined"},"_purpose":{"$ref":"#/components/schemas/Element"},"copyright":{"x-fhir-type":"markdown","type":"string","pattern":"^[\\s\\S]+$","description":"Use and/or publishing restrictions"},"_copyright":{"$ref":"#/components/schemas/Element"},"copyrightLabel":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Copyright holder and year(s)"},"_copyrightLabel":{"$ref":"#/components/schemas/Element"},"approvalDate":{"x-fhir-type":"date","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","description":"When the ValueSet was approved by publisher"},"_approvalDate":{"$ref":"#/components/schemas/Element"},"lastReviewDate":{"x-fhir-type":"date","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","description":"When the ValueSet was last reviewed by the publisher"},"_lastReviewDate":{"$ref":"#/components/schemas/Element"},"effectivePeriod":{"$ref":"#/components/schemas/Period","description":"When the ValueSet is expected to be used"},"topic":{"type":"array","description":"E.g. Education, Treatment, Assessment, etc","items":{"$ref":"#/components/schemas/CodeableConcept"}},"author":{"type":"array","description":"Who authored the ValueSet","items":{"$ref":"#/components/schemas/ContactDetail"}},"editor":{"type":"array","description":"Who edited the ValueSet","items":{"$ref":"#/components/schemas/ContactDetail"}},"reviewer":{"type":"array","description":"Who reviewed the ValueSet","items":{"$ref":"#/components/schemas/ContactDetail"}},"endorser":{"type":"array","description":"Who endorsed the ValueSet","items":{"$ref":"#/components/schemas/ContactDetail"}},"relatedArtifact":{"type":"array","description":"Additional documentation, citations, etc","items":{"$ref":"#/components/schemas/RelatedArtifact"}},"compose":{"$ref":"#/components/schemas/ValueSet_Compose","description":"Content logical definition of the value set (CLD)"},"expansion":{"$ref":"#/components/schemas/ValueSet_Expansion","description":"Used when the value set is \"expanded\""},"scope":{"$ref":"#/components/schemas/ValueSet_Scope","description":"Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description"}},"required":["resourceType","status"],"additionalProperties":false},"ValueSet_Compose":{"type":"object","description":"A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"lockedDate":{"x-fhir-type":"date","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","description":"Fixed date for references with no specified version (transitive)"},"_lockedDate":{"$ref":"#/components/schemas/Element"},"inactive":{"x-fhir-type":"boolean","type":"boolean","description":"Whether inactive codes are in the value set"},"_inactive":{"$ref":"#/components/schemas/Element"},"include":{"type":"array","description":"Include one or more codes from a code system or other value set(s)","items":{"$ref":"#/components/schemas/ValueSet_Compose_Include"}},"exclude":{"type":"array","description":"Explicitly exclude codes from a code system or other value sets","items":{"$ref":"#/components/schemas/ValueSet_Compose_Include"}},"property":{"type":"array","description":"Property to return if client doesn't override","items":{"anyOf":[{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$"},{"type":"null"}]}},"_property":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}}},"required":["include"],"additionalProperties":false},"ValueSet_Compose_Include":{"type":"object","description":"Include one or more codes from a code system or other value set(s).","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"system":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"The system the codes come from"},"_system":{"$ref":"#/components/schemas/Element"},"version":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Specific version of the code system referred to"},"_version":{"$ref":"#/components/schemas/Element"},"concept":{"type":"array","description":"A concept defined in the system","items":{"$ref":"#/components/schemas/ValueSet_Compose_Include_Concept"}},"filter":{"type":"array","description":"Select codes/concepts by their properties (including relationships)","items":{"$ref":"#/components/schemas/ValueSet_Compose_Include_Filter"}},"valueSet":{"type":"array","description":"Select the contents included in this value set","items":{"anyOf":[{"x-fhir-type":"canonical","type":"string","pattern":"^(\\S*)$"},{"type":"null"}]}},"_valueSet":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Element"},{"type":"null"}]}},"copyright":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"A copyright statement for the specific code system included in the value set"},"_copyright":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"ValueSet_Compose_Include_Concept":{"type":"object","description":"Specifies a concept to be included or excluded.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Code or expression from system"},"_code":{"$ref":"#/components/schemas/Element"},"display":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Text to display for this code for this value set in this valueset"},"_display":{"$ref":"#/components/schemas/Element"},"designation":{"type":"array","description":"Additional representations for this concept","items":{"$ref":"#/components/schemas/ValueSet_Compose_Include_Concept_Designation"}}},"required":["code"],"additionalProperties":false},"ValueSet_Compose_Include_Concept_Designation":{"type":"object","description":"Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"language":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Human language of the designation"},"_language":{"$ref":"#/components/schemas/Element"},"use":{"$ref":"#/components/schemas/Coding","description":"Types of uses of designations"},"additionalUse":{"type":"array","description":"Additional ways how this designation would be used","items":{"$ref":"#/components/schemas/Coding"}},"value":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"The text value for this designation"},"_value":{"$ref":"#/components/schemas/Element"}},"required":["value"],"additionalProperties":false},"ValueSet_Compose_Include_Filter":{"type":"object","description":"Select concepts by specifying a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified within the include, they SHALL all be true.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"property":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"A property/filter defined by the code system"},"_property":{"$ref":"#/components/schemas/Element"},"op":{"x-fhir-type":"code","type":"string","enum":["=","is-a","descendent-of","is-not-a","regex","in","not-in","generalizes","child-of","descendent-leaf","exists"],"description":"= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists"},"_op":{"$ref":"#/components/schemas/Element"},"value":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Code from the system, or regex criteria, or boolean value for exists"},"_value":{"$ref":"#/components/schemas/Element"}},"required":["property","op","value"],"additionalProperties":false},"ValueSet_Expansion":{"type":"object","description":"A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"identifier":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Identifies the value set expansion (business identifier)"},"_identifier":{"$ref":"#/components/schemas/Element"},"next":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Opaque urls for paging through expansion results"},"_next":{"$ref":"#/components/schemas/Element"},"timestamp":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Time ValueSet expansion happened"},"_timestamp":{"$ref":"#/components/schemas/Element"},"total":{"x-fhir-type":"integer","type":"integer","description":"Total number of codes in the expansion"},"_total":{"$ref":"#/components/schemas/Element"},"offset":{"x-fhir-type":"integer","type":"integer","description":"Offset at which this resource starts"},"_offset":{"$ref":"#/components/schemas/Element"},"parameter":{"type":"array","description":"Parameter that controlled the expansion process","items":{"$ref":"#/components/schemas/ValueSet_Expansion_Parameter"}},"property":{"type":"array","description":"Additional information supplied about each concept","items":{"$ref":"#/components/schemas/ValueSet_Expansion_Property"}},"contains":{"type":"array","description":"Codes in the value set","items":{"$ref":"#/components/schemas/ValueSet_Expansion_Contains"}}},"required":["timestamp"],"additionalProperties":false},"ValueSet_Expansion_Contains":{"type":"object","description":"The codes that are contained in the value set expansion.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"system":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"System value for the code"},"_system":{"$ref":"#/components/schemas/Element"},"abstract":{"x-fhir-type":"boolean","type":"boolean","description":"If user cannot select this entry"},"_abstract":{"$ref":"#/components/schemas/Element"},"inactive":{"x-fhir-type":"boolean","type":"boolean","description":"If concept is inactive in the code system"},"_inactive":{"$ref":"#/components/schemas/Element"},"version":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Version in which this code/display is defined"},"_version":{"$ref":"#/components/schemas/Element"},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Code - if blank, this is not a selectable code"},"_code":{"$ref":"#/components/schemas/Element"},"display":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"User display for the concept"},"_display":{"$ref":"#/components/schemas/Element"},"designation":{"type":"array","description":"Additional representations for this item","items":{"$ref":"#/components/schemas/ValueSet_Compose_Include_Concept_Designation"}},"property":{"type":"array","description":"Property value for the concept","items":{"$ref":"#/components/schemas/ValueSet_Expansion_Contains_Property"}},"contains":{"type":"array","description":"Codes contained under this entry","items":{"$ref":"#/components/schemas/ValueSet_Expansion_Contains"}}},"additionalProperties":false},"ValueSet_Expansion_Contains_Property":{"type":"object","description":"A property value for this concept.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Reference to ValueSet.expansion.property.code"},"_code":{"$ref":"#/components/schemas/Element"},"valueCode":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Value of the property for this concept"},"_valueCode":{"$ref":"#/components/schemas/Element"},"valueCoding":{"$ref":"#/components/schemas/Coding","description":"Value of the property for this concept"},"valueString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Value of the property for this concept"},"_valueString":{"$ref":"#/components/schemas/Element"},"valueInteger":{"x-fhir-type":"integer","type":"integer","description":"Value of the property for this concept"},"_valueInteger":{"$ref":"#/components/schemas/Element"},"valueBoolean":{"x-fhir-type":"boolean","type":"boolean","description":"Value of the property for this concept"},"_valueBoolean":{"$ref":"#/components/schemas/Element"},"valueDateTime":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Value of the property for this concept"},"_valueDateTime":{"$ref":"#/components/schemas/Element"},"valueDecimal":{"x-fhir-type":"decimal","type":"number","description":"Value of the property for this concept"},"_valueDecimal":{"$ref":"#/components/schemas/Element"},"subProperty":{"type":"array","description":"SubProperty value for the concept","items":{"$ref":"#/components/schemas/ValueSet_Expansion_Contains_Property_SubProperty"}}},"required":["code"],"additionalProperties":false},"ValueSet_Expansion_Contains_Property_SubProperty":{"type":"object","description":"A subproperty value for this concept.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Reference to ValueSet.expansion.property.code"},"_code":{"$ref":"#/components/schemas/Element"},"valueCode":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Value of the subproperty for this concept"},"_valueCode":{"$ref":"#/components/schemas/Element"},"valueCoding":{"$ref":"#/components/schemas/Coding","description":"Value of the subproperty for this concept"},"valueString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Value of the subproperty for this concept"},"_valueString":{"$ref":"#/components/schemas/Element"},"valueInteger":{"x-fhir-type":"integer","type":"integer","description":"Value of the subproperty for this concept"},"_valueInteger":{"$ref":"#/components/schemas/Element"},"valueBoolean":{"x-fhir-type":"boolean","type":"boolean","description":"Value of the subproperty for this concept"},"_valueBoolean":{"$ref":"#/components/schemas/Element"},"valueDateTime":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Value of the subproperty for this concept"},"_valueDateTime":{"$ref":"#/components/schemas/Element"},"valueDecimal":{"x-fhir-type":"decimal","type":"number","description":"Value of the subproperty for this concept"},"_valueDecimal":{"$ref":"#/components/schemas/Element"}},"required":["code"],"additionalProperties":false},"ValueSet_Expansion_Parameter":{"type":"object","description":"A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"name":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Name as assigned by the client or server"},"_name":{"$ref":"#/components/schemas/Element"},"valueString":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Value of the named parameter"},"_valueString":{"$ref":"#/components/schemas/Element"},"valueBoolean":{"x-fhir-type":"boolean","type":"boolean","description":"Value of the named parameter"},"_valueBoolean":{"$ref":"#/components/schemas/Element"},"valueInteger":{"x-fhir-type":"integer","type":"integer","description":"Value of the named parameter"},"_valueInteger":{"$ref":"#/components/schemas/Element"},"valueDecimal":{"x-fhir-type":"decimal","type":"number","description":"Value of the named parameter"},"_valueDecimal":{"$ref":"#/components/schemas/Element"},"valueUri":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Value of the named parameter"},"_valueUri":{"$ref":"#/components/schemas/Element"},"valueCode":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Value of the named parameter"},"_valueCode":{"$ref":"#/components/schemas/Element"},"valueDateTime":{"x-fhir-type":"dateTime","type":"string","pattern":"^(([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?)$","description":"Value of the named parameter"},"_valueDateTime":{"$ref":"#/components/schemas/Element"}},"required":["name"],"additionalProperties":false},"ValueSet_Expansion_Property":{"type":"object","description":"A property defines an additional slot through which additional information can be provided about a concept.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"code":{"x-fhir-type":"code","type":"string","pattern":"^([^\\s]+( [^\\s]+)*)$","description":"Identifies the property on the concepts, and when referred to in operations"},"_code":{"$ref":"#/components/schemas/Element"},"uri":{"x-fhir-type":"uri","type":"string","pattern":"^(\\S*)$","description":"Formal identifier for the property"},"_uri":{"$ref":"#/components/schemas/Element"}},"required":["code"],"additionalProperties":false},"ValueSet_Scope":{"type":"object","description":"Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.","properties":{"id":{"type":"string","description":"Unique id for inter-element referencing"},"extension":{"type":"array","description":"Additional content defined by implementations","items":{"$ref":"#/components/schemas/Extension"}},"modifierExtension":{"type":"array","description":"Extensions that cannot be ignored even if unrecognized","items":{"$ref":"#/components/schemas/Extension"}},"inclusionCriteria":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Criteria describing which concepts or codes should be included and why"},"_inclusionCriteria":{"$ref":"#/components/schemas/Element"},"exclusionCriteria":{"x-fhir-type":"string","type":"string","pattern":"^[\\s\\S]+$","description":"Criteria describing which concepts or codes should be excluded and why"},"_exclusionCriteria":{"$ref":"#/components/schemas/Element"}},"additionalProperties":false},"CodeSystemSearchBundle":{"description":"A searchset Bundle of CodeSystems","allOf":[{"$ref":"#/components/schemas/Bundle"},{"type":"object","properties":{"type":{"const":"searchset"},"entry":{"type":"array","items":{"type":"object","properties":{"resource":{"$ref":"#/components/schemas/CodeSystem"}}}}}}]},"ValueSetSearchBundle":{"description":"A searchset Bundle of ValueSets","allOf":[{"$ref":"#/components/schemas/Bundle"},{"type":"object","properties":{"type":{"const":"searchset"},"entry":{"type":"array","items":{"type":"object","properties":{"resource":{"$ref":"#/components/schemas/ValueSet"}}}}}}]},"ConceptMapSearchBundle":{"description":"A searchset Bundle of ConceptMaps","allOf":[{"$ref":"#/components/schemas/Bundle"},{"type":"object","properties":{"type":{"const":"searchset"},"entry":{"type":"array","items":{"type":"object","properties":{"resource":{"$ref":"#/components/schemas/ConceptMap"}}}}}}]}}}}