DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Issue-type.json

Raw JSON (canonical form)

Definition for Value SetIssueType

{
  "resourceType": "ValueSet",
  "id": "issue-type",
  "meta": {
    "lastUpdated": "2015-04-03T14:24:32.000+11:00",
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/valueset-shareable-definition"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/valueset-oid",
      "valueUri": "urn:oid:2.16.840.1.113883.4.642.2.121"
    }
  ],
  "url": "http://hl7.org/fhir/vs/issue-type",
  "version": "0.5.0",
  "name": "IssueType",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "A coded expression of the type of issue",
  "status": "draft",
  "experimental": false,
  "date": "2015-04-03T14:24:32+11:00",
  "define": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/valueset-oid",
        "valueUri": "urn:oid:2.16.840.1.113883.4.642.1.121"
      }
    ],
    "system": "http://hl7.org/fhir/issue-type",
    "caseSensitive": true,
    "concept": [
      {
        "code": "invalid",
        "display": "Invalid Content",
        "definition": "Content invalid against the Specification or a Profile.",
        "concept": [
          {
            "code": "structure",
            "display": "Structural Issue",
            "definition": "A structural issue in the content such as wrong namespace, or unable to parse the content completely, or invalid json syntax."
          },
          {
            "code": "required",
            "display": "Required element missing",
            "definition": "A required element is missing."
          },
          {
            "code": "value",
            "display": "Element value invalid",
            "definition": "element value invalid."
          },
          {
            "code": "invariant",
            "display": "Validation rule failed",
            "definition": "A content validation rule failed - e.g. a schematron rule."
          }
        ]
      },
      {
        "code": "security",
        "display": "Security Problem",
        "definition": "An authentication/authorization/permissions issueof some kind.",
        "concept": [
          {
            "code": "login",
            "display": "Login Required",
            "definition": "the client needs to initiate an authentication process."
          },
          {
            "code": "unknown",
            "display": "Unknown User",
            "definition": "The user or system was not able to be authenticated (either there is no process, or the proferred token is unacceptable)."
          },
          {
            "code": "expired",
            "display": "Session Expired",
            "definition": "User session expired; a login may be required."
          },
          {
            "code": "forbidden",
            "display": "Forbidden",
            "definition": "The user does not have the rights to perform this action."
          },
          {
            "code": "suppressed",
            "display": "Information  Suppressed",
            "definition": "Some information was not or may not have been returned due to business rules, consent or privacy rules, or access permission constraints.  This information may be accessible through alternate processes."
          }
        ]
      },
      {
        "code": "processing",
        "display": "Processing Failure",
        "definition": "Processing issues. These are expected to be final e.g. there is no point resubmitting the same content unchanged.",
        "concept": [
          {
            "code": "not-supported",
            "display": "Content not supported",
            "definition": "The resource or profile is not supported."
          },
          {
            "code": "duplicate",
            "display": "Duplicate",
            "definition": "An attempt was made to create a duplicate record."
          },
          {
            "code": "not-found",
            "display": "Not Found",
            "definition": "The reference provided was not found. In a pure RESTful environment, this would be an HTTP 404 error, but this code may be used where the content is not found further into the application architecture."
          },
          {
            "code": "too-long",
            "display": "Content Too Long",
            "definition": "Provided content is too long (typically, this is a denial of service protection type of error)."
          },
          {
            "code": "code-invalid",
            "display": "Invalid Code",
            "definition": "The code or system could not be understood, or it was not valid in the context of a particular ValueSet."
          },
          {
            "code": "extension",
            "display": "Unacceptable Extension",
            "definition": "An extension was found that was not acceptable, or that could not be resolved, or a modifierExtension that was not recognised."
          },
          {
            "code": "too-costly",
            "display": "Operation Too Costly",
            "definition": "The operation was stopped to protect server resources. E.g. a request for a value set expansion on all of SNOMED CT."
          },
          {
            "code": "business-rule",
            "display": "Business Rule Violation",
            "definition": "The content/operation failed to pass some business rule, and so could not proceed."
          },
          {
            "code": "conflict",
            "display": "Edit Version Conflict",
            "definition": "content could not be accepted because of an edit conflict (i.e. version aware updates) (In a pure RESTful environment, this would be an HTTP 404 error, but this code may be used where the conflict is discovered further into the application architecture)."
          },
          {
            "code": "incomplete",
            "display": "Incomplete Results",
            "definition": "Not all data sources typically accessed could be reached, or responded in time, so the returned information may not be complete."
          }
        ]
      },
      {
        "code": "transient",
        "display": "Transient Issue",
        "definition": "Transient processing issues. The system receiving the error may be able to resubmit the same content once an underlying issue is resolved.",
        "concept": [
          {
            "code": "lock-error",
            "display": "Lock Error",
            "definition": "A resource/record locking failure (usually in an underlying database)."
          },
          {
            "code": "no-store",
            "display": "No Store Available",
            "definition": "The persistent store unavailable. E.g. the database is down for maintenance or similar."
          },
          {
            "code": "exception",
            "display": "Exception",
            "definition": "An unexpected internal error."
          },
          {
            "code": "timeout",
            "display": "Timeout",
            "definition": "An internal timeout occurred."
          },
          {
            "code": "throttled",
            "display": "Throttled",
            "definition": "The system is not prepared to handle this request due to load management."
          }
        ]
      },
      {
        "code": "informational",
        "display": "Informational Note",
        "definition": "A message unrelated to the processing success of the completed operation (Examples of the latter include things like reminders of password expiry, system maintenance times, etc.)."
      }
    ]
  }
}

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.