Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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

Example CodeSystem/issue-type (Turtle)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw Turtle (+ also see Turtle/RDF Format Specification)

Definition for Code SystemIssueType

@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .

# - resource -------------------------------------------------------------------

[] a fhir:CodeSystem;
  fhir:Resource.id [ fhir:value "issue-type"];
  fhir:Resource.meta [
     fhir:Meta.lastUpdated [ fhir:value "2022-09-10T04:52:37.223+10:00" ];
     fhir:Meta.profile [ fhir:value "http://hl7.org/fhir/StructureDefinition/shareablecodesystem" ]
  ];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ]
  ];
  fhir:DomainResource.extension [
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" ];
     fhir:Extension.value [ fhir:value "fhir" ]
  ], [
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ];
     fhir:Extension.value [ fhir:value "normative" ]
  ], [
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ];
     fhir:Extension.value [ fhir:value "4.0.0" ]
  ], [
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ];
     fhir:Extension.value [ fhir:value "5" ]
  ];
  fhir:CanonicalResource.url [ fhir:value "http://hl7.org/fhir/issue-type"];
  fhir:CanonicalResource.identifier [
     fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ];
     fhir:Identifier.value [ fhir:value "urn:oid:2.16.840.1.113883.4.642.4.411" ]
  ];
  fhir:CanonicalResource.version [ fhir:value "5.0.0-ballot"];
  fhir:CanonicalResource.name [ fhir:value "IssueType"];
  fhir:CanonicalResource.title [ fhir:value "IssueType"];
  fhir:CanonicalResource.status [ fhir:value "active"];
  fhir:CanonicalResource.experimental [ fhir:value "false"];
  fhir:CanonicalResource.date [ fhir:value "2021-01-05T10:01:24+11:00"];
  fhir:CanonicalResource.publisher [ fhir:value "HL7 (FHIR Project)"];
  fhir:CanonicalResource.contact [
     fhir:ContactDetail.telecom [
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
     ], [
       fhir:ContactPoint.system [ fhir:value "email" ];
       fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ]
     ]
  ];
  fhir:CanonicalResource.description [ fhir:value "A code that describes the type of issue."];
  fhir:CodeSystem.url [ fhir:value "http://hl7.org/fhir/issue-type"];
  fhir:CodeSystem.identifier [
     fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ];
     fhir:Identifier.value [ fhir:value "urn:oid:2.16.840.1.113883.4.642.4.411" ]
  ];
  fhir:CodeSystem.version [ fhir:value "5.0.0-ballot"];
  fhir:CodeSystem.name [ fhir:value "IssueType"];
  fhir:CodeSystem.title [ fhir:value "IssueType"];
  fhir:CodeSystem.status [ fhir:value "active"];
  fhir:CodeSystem.experimental [ fhir:value "false"];
  fhir:CodeSystem.date [ fhir:value "2021-01-05T10:01:24+11:00"];
  fhir:CodeSystem.publisher [ fhir:value "HL7 (FHIR Project)"];
  fhir:CodeSystem.contact [
     fhir:ContactDetail.telecom [
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
     ], [
       fhir:ContactPoint.system [ fhir:value "email" ];
       fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ]
     ]
  ];
  fhir:CodeSystem.description [ fhir:value "A code that describes the type of issue."];
  fhir:CodeSystem.caseSensitive [ fhir:value "true"];
  fhir:CodeSystem.valueSet [ fhir:value "http://hl7.org/fhir/ValueSet/issue-type"];
  fhir:CodeSystem.hierarchyMeaning [ fhir:value "is-a"];
  fhir:CodeSystem.content [ fhir:value "complete"];
  fhir:CodeSystem.concept [
     fhir:ConceptDefinitionComponent.code [ fhir:value "invalid" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Invalid Content" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Content invalid against the specification or a profile." ];
     fhir:ConceptDefinitionComponent.concept [
       fhir:ConceptDefinitionComponent.code [ fhir:value "structure" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Structural Issue" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "A structural issue in the content such as wrong namespace, unable to parse the content completely, invalid syntax, etc." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "required" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Required element missing" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "A required element is missing." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "value" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Element value invalid" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "An element or header value is invalid." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "invariant" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Validation rule failed" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "A content validation rule failed - e.g. a schematron rule." ]
     ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "security" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Security Problem" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "An authentication/authorization/permissions issue of some kind." ];
     fhir:ConceptDefinitionComponent.concept [
       fhir:ConceptDefinitionComponent.code [ fhir:value "login" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Login Required" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "The client needs to initiate an authentication process." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "unknown" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Unknown User" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "The user or system was not able to be authenticated (either there is no process, or the proferred token is unacceptable)." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "expired" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Session Expired" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "User session expired; a login may be required." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "forbidden" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Forbidden" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "The user does not have the rights to perform this action." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "suppressed" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Information  Suppressed" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "Some information was not or might not have been returned due to business rules, consent or privacy rules, or access permission constraints.  This information may be accessible through alternate processes." ]
     ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "processing" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Processing Failure" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Processing issues. These are expected to be final e.g. there is no point resubmitting the same content unchanged." ];
     fhir:ConceptDefinitionComponent.concept [
       fhir:ConceptDefinitionComponent.code [ fhir:value "not-supported" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Content not supported" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "The interaction, operation, resource or profile is not supported." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "duplicate" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Duplicate" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "An attempt was made to create a duplicate record." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "multiple-matches" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Multiple Matches" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "Multiple matching records were found when the operation required only one match." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "not-found" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Not Found" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "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." ];
       fhir:ConceptDefinitionComponent.concept [
         fhir:ConceptDefinitionComponent.code [ fhir:value "deleted" ];
         fhir:ConceptDefinitionComponent.display [ fhir:value "Deleted" ];
         fhir:ConceptDefinitionComponent.definition [ fhir:value "The reference pointed to content (usually a resource) that has been deleted." ]
       ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "too-long" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Content Too Long" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "Provided content is too long (typically, this is a denial of service protection type of error)." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "code-invalid" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Invalid Code" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "The code or system could not be understood, or it was not valid in the context of a particular ValueSet.code." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "extension" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Unacceptable Extension" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "An extension was found that was not acceptable, could not be resolved, or a modifierExtension was not recognized." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "too-costly" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Operation Too Costly" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "The operation was stopped to protect server resources; e.g. a request for a value set expansion on all of SNOMED CT." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "business-rule" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Business Rule Violation" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "The content/operation failed to pass some business rule and so could not proceed." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "conflict" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Edit Version Conflict" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "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 409 error, but this code may be used where the conflict is discovered further into the application architecture.)." ]
     ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "transient" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Transient Issue" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Transient processing issues. The system receiving the message may be able to resubmit the same content once an underlying issue is resolved." ];
     fhir:ConceptDefinitionComponent.concept [
       fhir:ConceptDefinitionComponent.code [ fhir:value "lock-error" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Lock Error" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "A resource/record locking failure (usually in an underlying database)." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "no-store" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "No Store Available" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "The persistent store is unavailable; e.g. the database is down for maintenance or similar action, and the interaction or operation cannot be processed." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "exception" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Exception" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "An unexpected internal error has occurred." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "timeout" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Timeout" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "An internal timeout has occurred." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "incomplete" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Incomplete Results" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "Not all data sources typically accessed could be reached or responded in time, so the returned information might not be complete (applies to search interactions and some operations)." ]
     ], [
       fhir:ConceptDefinitionComponent.code [ fhir:value "throttled" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "Throttled" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "The system is not prepared to handle this request due to load management." ]
     ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "informational" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Informational Note" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "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.