FHIR Release 3 (STU) 4

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

Codesystem-endpoint-status.xml

Vocabulary Patient Administration Work Group Maturity Level : N/A Ballot Standards Status : Informative

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

Definition for Code System EndpointStatus

<?xml version="1.0" encoding="UTF-8"?>


<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="endpoint-status"/> 
  <meta> 
    

    <lastUpdated value="2019-11-01T09:29:23.356+11:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> EndpointStatus</h2> 
      <div> 
        

        <p> The status of the endpoint.</p> 

      </div> 
      <p> This code system http://hl7.org/fhir/endpoint-status 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> 
          active

          <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> 
          suspended

          <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> 
          error

          <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

             and should no longer be attempted to connect to until corrective action is taken.</td> 

        </tr> 
        <tr> 
          off

          <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> 
          entered-in-error

          <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> 
        <tr> 
          test

          <td style="white-space:nowrap">test
            <a name="endpoint-status-test"> </a> 
          </td> 
          <td> Test</td> 
          <td> This endpoint is not intended for production usage.</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  
    

  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pa"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="2"/> 
  </extension> 
  
    
  

  <url value="http://hl7.org/fhir/endpoint-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    

    <value value="urn:oid:2.16.840.1.113883.4.642.4.495"/> 
  </identifier> 
  

  <version value="4.0.1"/> 
  <name value="EndpointStatus"/> 
  <title value="EndpointStatus"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  

  <date value="2019-11-01T09:29:23+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  

  <description value="The status of the endpoint."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/endpoint-status"/> 
  <content value="complete"/> 
  <concept> 
    <code value="active"/> 
    <display value="Active"/> 
    

    <definition value="This endpoint is expected to be active and can be used."/> 
  </concept> 
  <concept> 
    <code value="suspended"/> 
    <display value="Suspended"/> 
    

    <definition value="This endpoint is temporarily unavailable."/> 
  </concept> 
  <concept> 
    <code value="error"/> 
    <display value="Error"/> 
    <definition value="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

     and should no longer be attempted to connect to until corrective action is taken."/> 

  </concept> 
  <concept> 
    <code value="off"/> 
    <display value="Off"/> 
    

    <definition value="This endpoint is no longer to be used."/> 
  </concept> 
  <concept> 
    <code value="entered-in-error"/> 
    <display value="Entered in error"/> 
    <definition value="This instance should not have been part of this patient's medical record."/> 
  </concept> 
  <concept> 
    <code value="test"/> 
    <display value="Test"/> 
    <definition value="This endpoint is not intended for production usage."/> 
  </concept> 


</

CodeSystem

>



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.