FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example CodeSystem/endpoint-status (JSON)

Patient Administration Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

Definition for Code SystemEndpointStatus

{
  "resourceType" : "CodeSystem",
  "id" : "endpoint-status",
  "meta" : {
    "lastUpdated" : "2024-12-13T05:56:29.677+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem endpoint-status</b></p><a name=\"endpoint-status\"> </a><a name=\"hcendpoint-status\"> </a><a name=\"endpoint-status-en-US\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Last updated: 2021-01-05T10:01:24.148+11:00</p><p style=\"margin-bottom: 0px\">Profile: <a href=\"shareablecodesystem.html\">Shareable CodeSystem</a></p></div><p>This case-sensitive code system <code>http://hl7.org/fhir/endpoint-status</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\">active<a name=\"endpoint-status-active\"> </a></td><td>Active</td><td>This endpoint is expected to be active and can be used.</td></tr><tr><td style=\"white-space:nowrap\">limited<a name=\"endpoint-status-limited\"> </a></td><td>Limited</td><td>This endpoint is available for limited use (for example, it is undergoing internal testing).  I.e. the endpoint is not fully available, might not always be available, or might only be available for some users.</td></tr><tr><td style=\"white-space:nowrap\">suspended<a name=\"endpoint-status-suspended\"> </a></td><td>Suspended</td><td>This endpoint is temporarily unavailable.</td></tr><tr><td style=\"white-space:nowrap\">error<a name=\"endpoint-status-error\"> </a></td><td>Error</td><td>This endpoint has exceeded connectivity thresholds and is considered in an error state and should no longer be attempted to connect to until corrective action is taken.</td></tr><tr><td style=\"white-space:nowrap\">off<a name=\"endpoint-status-off\"> </a></td><td>Off</td><td>This endpoint is no longer to be used.</td></tr><tr><td style=\"white-space:nowrap\">entered-in-error<a name=\"endpoint-status-entered-in-error\"> </a></td><td>Entered in error</td><td>This instance should not have been part of this patient's medical record.</td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "pa"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 2
  }],
  "url" : "http://hl7.org/fhir/endpoint-status",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.495"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.1.488"
  }],
  "version" : "6.0.0-ballot2",
  "name" : "EndpointStatus",
  "title" : "Endpoint Status",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-01-05T10:01:24+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "The status of the endpoint.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/endpoint-status",
  "content" : "complete",
  "concept" : [{
    "code" : "active",
    "display" : "Active",
    "definition" : "This endpoint is expected to be active and can be used."
  },
  {
    "code" : "limited",
    "display" : "Limited",
    "definition" : "This endpoint is available for limited use (for example, it is undergoing internal testing).  I.e. the endpoint is not fully available, might not always be available, or might only be available for some users."
  },
  {
    "code" : "suspended",
    "display" : "Suspended",
    "definition" : "This endpoint is temporarily unavailable."
  },
  {
    "code" : "error",
    "display" : "Error",
    "definition" : "This endpoint has exceeded connectivity thresholds and is considered in an error state and should no longer be attempted to connect to until corrective action is taken."
  },
  {
    "code" : "off",
    "display" : "Off",
    "definition" : "This endpoint is no longer to be used."
  },
  {
    "code" : "entered-in-error",
    "display" : "Entered in error",
    "definition" : "This instance should not have been part of this patient's medical record."
  }]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.