HL7 Terminology
2.1.0 - Publication

This page is part of the HL7 Terminology (v2.1.0: Release) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

: EntityStatus - JSON Representation

Raw json | Download


{
  "resourceType" : "CodeSystem",
  "id" : "v3-EntityStatus",
  "language" : "en",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\"><p><b>Properties</b></p><table class=\"grid\"><tr><td><b>Code</b></td><td><b>URL</b></td><td><b>Description</b></td><td><b>Type</b></td></tr><tr><td>Specializes</td><td/><td>The child code is a more narrow version of the concept represented by the parent code.  I.e. Every child concept is also a valid parent concept.  Used to allow determination of subsumption.  Must be transitive, irreflexive, antisymmetric.</td><td>Coding</td></tr><tr><td>Generalizes</td><td/><td>Inverse of Specializes.  Only included as a derived relationship.</td><td>Coding</td></tr><tr><td>internalId</td><td>http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id</td><td>The internal identifier for the concept in the HL7 Access database repository.</td><td>code</td></tr><tr><td>status</td><td>http://hl7.org/fhir/concept-properties#status</td><td>Designation of a concept's state.  Normally is not populated unless the state is retired..</td><td>code</td></tr></table><p>This code system http://terminology.hl7.org/CodeSystem/v3-EntityStatus defines the following codes:</p><table class=\"codes\"><tr><td><b>Lvl</b></td><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td><td><b>internalId</b></td><td><b>status</b></td></tr><tr><td>1</td><td style=\"white-space:nowrap\">normal<a name=\"v3-EntityStatus-normal\"> </a></td><td>normal</td><td>The 'typical' state. Excludes &quot;nullified&quot; which represents the termination state of an Entity record instance that was created in error.</td><td>16006</td><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  active<a name=\"v3-EntityStatus-active\"> </a></td><td>active</td><td>The state representing the fact that the Entity record is currently active.</td><td>16007</td><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  inactive<a name=\"v3-EntityStatus-inactive\"> </a></td><td>inactive</td><td>**Definition:** The state representing the fact that the entity is inactive.</td><td>22187</td><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  terminated<a name=\"v3-EntityStatus-terminated\"> </a></td><td>terminated</td><td>The state representing the normal termination of an Entity record.</td><td>16008</td><td>retired</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">nullified<a name=\"v3-EntityStatus-nullified\"> </a></td><td>nullified</td><td>The state representing the termination of an Entity record instance that was created in error.</td><td>16009</td><td>active</td></tr></table></div>"
  },
  "url" : "http://terminology.hl7.org/CodeSystem/v3-EntityStatus",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.5.1061"
    }
  ],
  "version" : "2.0.0",
  "name" : "EntityStatus",
  "title" : "EntityStatus",
  "status" : "active",
  "date" : "2019-03-20",
  "publisher" : "Health Level 7",
  "contact" : [
    {
      "name" : "Health Level Seven"
    }
  ],
  "description" : "Codes representing the defined possible states of an Entity, as defined by the Entity class state machine.",
  "hierarchyMeaning" : "is-a",
  "content" : "complete",
  "property" : [
    {
      "extension" : [
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry",
          "valueCode" : "antisymmetric"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity",
          "valueCode" : "transitive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity",
          "valueCode" : "irreflexive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable",
          "valueBoolean" : true
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind",
          "valueCode" : "Specializes"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName",
          "valueString" : "Generalizes"
        }
      ],
      "code" : "Specializes",
      "description" : "The child code is a more narrow version of the concept represented by the parent code.  I.e. Every child concept is also a valid parent concept.  Used to allow determination of subsumption.  Must be transitive, irreflexive, antisymmetric.",
      "type" : "Coding"
    },
    {
      "extension" : [
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry",
          "valueCode" : "antisymmetric"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity",
          "valueCode" : "transitive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity",
          "valueCode" : "irreflexive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable",
          "valueBoolean" : true
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind",
          "valueCode" : "Generalizes"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName",
          "valueString" : "Specializes"
        }
      ],
      "code" : "Generalizes",
      "description" : "Inverse of Specializes.  Only included as a derived relationship.",
      "type" : "Coding"
    },
    {
      "code" : "internalId",
      "uri" : "http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id",
      "description" : "The internal identifier for the concept in the HL7 Access database repository.",
      "type" : "code"
    },
    {
      "code" : "status",
      "uri" : "http://hl7.org/fhir/concept-properties#status",
      "description" : "Designation of a concept's state.  Normally is not populated unless the state is retired..",
      "type" : "code"
    }
  ],
  "concept" : [
    {
      "code" : "normal",
      "display" : "normal",
      "definition" : "The 'typical' state. Excludes \"nullified\" which represents the termination state of an Entity record instance that was created in error.",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "16006"
        }
      ],
      "concept" : [
        {
          "code" : "active",
          "display" : "active",
          "definition" : "The state representing the fact that the Entity record is currently active.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "16007"
            }
          ]
        },
        {
          "code" : "inactive",
          "display" : "inactive",
          "definition" : "**Definition:** The state representing the fact that the entity is inactive.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "22187"
            }
          ]
        },
        {
          "code" : "terminated",
          "display" : "terminated",
          "definition" : "The state representing the normal termination of an Entity record.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "retired"
            },
            {
              "code" : "internalId",
              "valueCode" : "16008"
            }
          ]
        }
      ]
    },
    {
      "code" : "nullified",
      "display" : "nullified",
      "definition" : "The state representing the termination of an Entity record instance that was created in error.",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "16009"
        }
      ]
    }
  ]
}