FHIR Tooling Extensions IG, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/FHIR/fhir-tools-ig/ and changes regularly. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Additional Binding Purpose Codes - JSON Representation

Raw json | Download

{
  "resourceType" : "CodeSystem",
  "id" : "additional-binding-purpose",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div xml:lang=\"en\" lang=\"en\"><hr/><p><b>English</b></p><hr/><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem additional-binding-purpose</b></p><a name=\"additional-binding-purpose\"> </a><a name=\"hcadditional-binding-purpose\"> </a><a name=\"additional-binding-purpose-en\"> </a><p>This case-sensitive code system <code>http://hl7.org/fhir/tools/CodeSystem/additional-binding-purpose</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">maximum<a name=\"additional-binding-purpose-maximum\"> </a></td><td>Maximum Binding</td><td>A required binding, for use when the binding strength is 'extensible' or 'preferred'</td></tr><tr><td style=\"white-space:nowrap\">minimum<a name=\"additional-binding-purpose-minimum\"> </a></td><td>Minimum Binding</td><td>The minimum allowable value set - any conformant system SHALL support all these codes</td></tr><tr><td style=\"white-space:nowrap\">required<a name=\"additional-binding-purpose-required\"> </a></td><td>Required Binding</td><td>This value set is used as a required binding (in addition to the base binding (not a replacement), usually in a particular usage context)</td></tr><tr><td style=\"white-space:nowrap\">extensible<a name=\"additional-binding-purpose-extensible\"> </a></td><td>Conformance Binding</td><td>This value set is used as an extensible binding (in addition to the base binding (not a replacement), usually in a particular usage context)</td></tr><tr><td style=\"white-space:nowrap\">candidate<a name=\"additional-binding-purpose-candidate\"> </a></td><td>Candidate Binding</td><td>This value set is a candidate to substitute for the overall conformance value set in some situations; usually these are defined in the documentation</td></tr><tr><td style=\"white-space:nowrap\">current<a name=\"additional-binding-purpose-current\"> </a></td><td>Current Binding</td><td>New records are required to use this value set, but legacy records may use other codes. The definition of 'new record' is difficult, since systems often create new records based on pre-existing data. Usually 'current' bindings are mandated by an external authority that makes clear rules around this</td></tr><tr><td style=\"white-space:nowrap\">preferred<a name=\"additional-binding-purpose-preferred\"> </a></td><td>Preferred Binding</td><td>This is the value set that is preferred in a given context (documentation should explain why)</td></tr><tr><td style=\"white-space:nowrap\">ui<a name=\"additional-binding-purpose-ui\"> </a></td><td>UI Suggested Binding</td><td>This value set is provided for user look up in a given context. Typically, these valuesets only include a subset of codes relevant for input in a context</td></tr><tr><td style=\"white-space:nowrap\">starter<a name=\"additional-binding-purpose-starter\"> </a></td><td>Starter Binding</td><td>This value set is a good set of codes to start with when designing your system</td></tr><tr><td style=\"white-space:nowrap\">component<a name=\"additional-binding-purpose-component\"> </a></td><td>Component Binding</td><td>This value set is a component of the base value set. Usually this is called out so that documentation can be written about a portion of the value set</td></tr></table></div><div xml:lang=\"es\" lang=\"es\"><hr/><p><b>Spanish</b></p><hr/><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem additional-binding-purpose</b></p><a name=\"additional-binding-purpose\"> </a><a name=\"hcadditional-binding-purpose\"> </a><a name=\"additional-binding-purpose-es\"> </a><p>This case-sensitive code system <code>http://hl7.org/fhir/tools/CodeSystem/additional-binding-purpose</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style=\"white-space:nowrap\">maximum<a name=\"additional-binding-purpose-maximum\"> </a></td><td>Maximum Binding</td><td>A required binding, for use when the binding strength is 'extensible' or 'preferred'</td></tr><tr><td style=\"white-space:nowrap\">minimum<a name=\"additional-binding-purpose-minimum\"> </a></td><td>Minimum Binding</td><td>The minimum allowable value set - any conformant system SHALL support all these codes</td></tr><tr><td style=\"white-space:nowrap\">required<a name=\"additional-binding-purpose-required\"> </a></td><td>Required Binding</td><td>This value set is used as a required binding (in addition to the base binding (not a replacement), usually in a particular usage context)</td></tr><tr><td style=\"white-space:nowrap\">extensible<a name=\"additional-binding-purpose-extensible\"> </a></td><td>Conformance Binding</td><td>This value set is used as an extensible binding (in addition to the base binding (not a replacement), usually in a particular usage context)</td></tr><tr><td style=\"white-space:nowrap\">candidate<a name=\"additional-binding-purpose-candidate\"> </a></td><td>Candidate Binding</td><td>This value set is a candidate to substitute for the overall conformance value set in some situations; usually these are defined in the documentation</td></tr><tr><td style=\"white-space:nowrap\">current<a name=\"additional-binding-purpose-current\"> </a></td><td>Current Binding</td><td>New records are required to use this value set, but legacy records may use other codes. The definition of 'new record' is difficult, since systems often create new records based on pre-existing data. Usually 'current' bindings are mandated by an external authority that makes clear rules around this</td></tr><tr><td style=\"white-space:nowrap\">preferred<a name=\"additional-binding-purpose-preferred\"> </a></td><td>Preferred Binding</td><td>This is the value set that is preferred in a given context (documentation should explain why)</td></tr><tr><td style=\"white-space:nowrap\">ui<a name=\"additional-binding-purpose-ui\"> </a></td><td>UI Suggested Binding</td><td>This value set is provided for user look up in a given context. Typically, these valuesets only include a subset of codes relevant for input in a context</td></tr><tr><td style=\"white-space:nowrap\">starter<a name=\"additional-binding-purpose-starter\"> </a></td><td>Starter Binding</td><td>This value set is a good set of codes to start with when designing your system</td></tr><tr><td style=\"white-space:nowrap\">component<a name=\"additional-binding-purpose-component\"> </a></td><td>Component Binding</td><td>This value set is a component of the base value set. Usually this is called out so that documentation can be written about a portion of the value set</td></tr></table></div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fhir"
    }
  ],
  "url" : "http://hl7.org/fhir/tools/CodeSystem/additional-binding-purpose",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.4.642.40.1.16.5"
    }
  ],
  "version" : "0.3.0",
  "name" : "AdditionalBindingPurposeCodes",
  "title" : "Additional Binding Purpose Codes",
  "status" : "active",
  "experimental" : false,
  "date" : "2024-12-13T16:48:38+00:00",
  "publisher" : "HL7 International / FHIR Infrastructure",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description" : "Additional Binding Purpose",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "caseSensitive" : true,
  "content" : "complete",
  "concept" : [
    {
      "code" : "maximum",
      "display" : "Maximum Binding",
      "definition" : "A required binding, for use when the binding strength is 'extensible' or 'preferred'"
    },
    {
      "code" : "minimum",
      "display" : "Minimum Binding",
      "definition" : "The minimum allowable value set - any conformant system SHALL support all these codes"
    },
    {
      "code" : "required",
      "display" : "Required Binding",
      "definition" : "This value set is used as a required binding (in addition to the base binding (not a replacement), usually in a particular usage context)"
    },
    {
      "code" : "extensible",
      "display" : "Conformance Binding",
      "definition" : "This value set is used as an extensible binding (in addition to the base binding (not a replacement), usually in a particular usage context)"
    },
    {
      "code" : "candidate",
      "display" : "Candidate Binding",
      "definition" : "This value set is a candidate to substitute for the overall conformance value set in some situations; usually these are defined in the documentation"
    },
    {
      "code" : "current",
      "display" : "Current Binding",
      "definition" : "New records are required to use this value set, but legacy records may use other codes. The definition of 'new record' is difficult, since systems often create new records based on pre-existing data. Usually 'current' bindings are mandated by an external authority that makes clear rules around this"
    },
    {
      "code" : "preferred",
      "display" : "Preferred Binding",
      "definition" : "This is the value set that is preferred in a given context (documentation should explain why)"
    },
    {
      "code" : "ui",
      "display" : "UI Suggested Binding",
      "definition" : "This value set is provided for user look up in a given context. Typically, these valuesets only include a subset of codes relevant for input in a context"
    },
    {
      "code" : "starter",
      "display" : "Starter Binding",
      "definition" : "This value set is a good set of codes to start with when designing your system"
    },
    {
      "code" : "component",
      "display" : "Component Binding",
      "definition" : "This value set is a component of the base value set. Usually this is called out so that documentation can be written about a portion of the value set"
    }
  ]
}