R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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: R4B R4 R3 R2

Valueset-template-status-code.json

Vocabulary Work GroupMaturity Level: N/ABallot Status: Informative

Raw JSON (canonical form)

Definition for Value SetTemplateStatusCode

{
  "resourceType": "ValueSet",
  "id": "template-status-code",
  "meta": {
    "lastUpdated": "2017-12-20T15:52:34.818+11:00",
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/shareablevalueset"
    ]
  },
  "text": {
    "status": "extensions",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueString": "fhir"
    }
  ],
  "url": "http://hl7.org/fhir/ValueSet/template-status-code",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.3.923"
    }
  ],
  "version": "3.2.0",
  "name": "TemplateStatusCode",
  "status": "draft",
  "experimental": false,
  "date": "2017-12-20T15:52:34+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 indicates the level of maturity of the design and may be used to manage the use of the design",
  "compose": {
    "include": [
      {
        "system": "urn:oid:2.16.840.1.113883.3.1937.98.5.8",
        "concept": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/valueset-definition",
                "valueString": "Design is under development (nascent)"
              }
            ],
            "code": "draft",
            "display": "Draft"
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/valueset-definition",
                "valueString": "Design is completed and is being reviewed"
              }
            ],
            "code": "pending",
            "display": "Under pre-publication review"
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/valueset-definition",
                "valueString": "Design has been deemed fit for the intended purpose and is published by the governance group"
              }
            ],
            "code": "active",
            "display": "Active"
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/valueset-definition",
                "valueString": "Design is active, but is under review. The review may result in a change to the design. The change may necessitate a new version to be created. This in turn may result in the prior version of the template to be retired. Alternatively, the review may result in a change to the design that does not require a new version to be created, or it may result in no change to the design at all"
              }
            ],
            "code": "review",
            "display": "In Review"
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/valueset-definition",
                "valueString": "A drafted design is determined to be erroneous or not fit for intended purpose and is discontinued before ever being published in an active state"
              }
            ],
            "code": "cancelled",
            "display": "Cancelled"
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/valueset-definition",
                "valueString": "A previously drafted design is determined to be erroneous or not fit for intended purpose and is discontinued before ever being published for consideration in a pending state"
              }
            ],
            "code": "rejected",
            "display": "Rejected"
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/valueset-definition",
                "valueString": "A previously active design is discontinued from use. It should no longer be used for future designs, but for historical purposes may be used to process data previously recorded using this design. A newer design might or might not exist. The design is published in the retired state"
              }
            ],
            "code": "retired",
            "display": "Retired"
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/valueset-definition",
                "valueString": "A design is determined to be erroneous or not fit for the intended purpose and should no longer be used, even for historical purposes. No new designs can be developed for this template. The associated template no longer needs to be published, but if published, is shown in the terminated state"
              }
            ],
            "code": "terminated",
            "display": "Terminated"
          }
        ]
      }
    ]
  }
}

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.