Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CodeSystem/response-code (JSON)

Infrastructure And Messaging Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemResponseType

{
  "resourceType" : "CodeSystem",
  "id" : "response-code",
  "meta" : {
    "lastUpdated" : "2023-03-26T15:21:02.749+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This code system <code>http://hl7.org/fhir/response-code</code> 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><td style=\"white-space:nowrap\">ok<a name=\"response-code-ok\"> </a></td><td>OK</td><td>The message was accepted and processed without error.</td></tr><tr><td style=\"white-space:nowrap\">transient-error<a name=\"response-code-transient-error\"> </a></td><td>Transient Error</td><td>Some internal unexpected error occurred - wait and try again. Note - this is usually used for things like database unavailable, which may be expected to resolve, though human intervention may be required.</td></tr><tr><td style=\"white-space:nowrap\">fatal-error<a name=\"response-code-fatal-error\"> </a></td><td>Fatal Error</td><td>The message was rejected because of a problem with the content. There is no point in re-sending without change. The response narrative SHALL describe the issue.</td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "inm"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 4
  }],
  "url" : "http://hl7.org/fhir/response-code",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.381"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.1.368"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.2.203"
  }],
  "version" : "5.0.0",
  "name" : "ResponseType",
  "title" : "Response Type",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-01-05T10:01:24+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "The kind of response to a message.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/response-code",
  "content" : "complete",
  "concept" : [{
    "code" : "ok",
    "display" : "OK",
    "definition" : "The message was accepted and processed without error."
  },
  {
    "code" : "transient-error",
    "display" : "Transient Error",
    "definition" : "Some internal unexpected error occurred - wait and try again. Note - this is usually used for things like database unavailable, which may be expected to resolve, though human intervention may be required."
  },
  {
    "code" : "fatal-error",
    "display" : "Fatal Error",
    "definition" : "The message was rejected because of a problem with the content. There is no point in re-sending without change. The response narrative SHALL describe the issue."
  }]
}

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.