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/resource-status (Turtle)

Modeling and Methodology Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemCanonical Status Codes for FHIR Resources

@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 "resource-status"];
  fhir:Resource.meta [
     fhir:Meta.lastUpdated [ fhir:value "2022-09-10T04:52:37.223+10:00" ]
  ];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ]
  ];
  fhir:DomainResource.extension [
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ];
     fhir:Extension.value [ fhir:value "trial-use" ]
  ], [
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ];
     fhir:Extension.value [ fhir:value "3" ]
  ], [
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" ];
     fhir:Extension.value [ fhir:value "mnm" ]
  ];
  fhir:CanonicalResource.url [ fhir:value "http://hl7.org/fhir/resource-status"];
  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.1828" ]
  ];
  fhir:CanonicalResource.version [ fhir:value "5.0.0-ballot"];
  fhir:CanonicalResource.name [ fhir:value "Canonical Status Codes for FHIR Resources"];
  fhir:CanonicalResource.status [ fhir:value "draft"];
  fhir:CanonicalResource.experimental [ fhir:value "false"];
  fhir:CanonicalResource.publisher [ fhir:value "FHIR Project"];
  fhir:CanonicalResource.description [ fhir:value "The master set of status codes used throughout FHIR. All status codes are mapped to one of these codes."];
  fhir:CodeSystem.url [ fhir:value "http://hl7.org/fhir/resource-status"];
  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.1828" ]
  ];
  fhir:CodeSystem.version [ fhir:value "5.0.0-ballot"];
  fhir:CodeSystem.name [ fhir:value "Canonical Status Codes for FHIR Resources"];
  fhir:CodeSystem.status [ fhir:value "draft"];
  fhir:CodeSystem.experimental [ fhir:value "false"];
  fhir:CodeSystem.publisher [ fhir:value "FHIR Project"];
  fhir:CodeSystem.description [ fhir:value "The master set of status codes used throughout FHIR. All status codes are mapped to one of these codes."];
  fhir:CodeSystem.caseSensitive [ fhir:value "true"];
  fhir:CodeSystem.valueSet [ fhir:value "http://hl7.org/fhir/ValueSet/resource-status"];
  fhir:CodeSystem.hierarchyMeaning [ fhir:value "is-a"];
  fhir:CodeSystem.content [ fhir:value "complete"];
  fhir:CodeSystem.concept [
     fhir:ConceptDefinitionComponent.code [ fhir:value "error" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "error" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The resource was created in error, and should not be treated as valid (note: in many cases, for various data integrity related reasons, the information cannot be removed from the record)" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "proposed" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "proposed" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The resource describes an action or plan that is proposed, and not yet approved by the participants" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "planned" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "planned" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The resource describes a course of action that is planned and agreed/approved, but at the time of recording was still future" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "draft" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "draft" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The information in the resource is still being prepared and edited" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "requested" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "requested" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "A fulfiller has been asked to perform this action, but it has not yet occurred" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "received" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "received" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The fulfiller has received the request, but not yet agreed to carry out the action" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "declined" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "declined" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The fulfiller chose not to perform the action" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "accepted" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "accepted" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The fulfiller has decided to perform the action, and plans are in train to do this in the future" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "arrived" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "arrived" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The pre-conditions for the action are all fulfilled, and it is imminent" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "active" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "active" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The resource describes information that is currently valid or a process that is presently occuring" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "suspended" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "suspended" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The process described/requested in this resource has been halted for some reason" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "failed" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "failed" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The process described/requested in the resource could not be completed, and no further action is planned" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "replaced" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "replaced" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The information in this resource has been replaced by information in another resource" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "complete" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "complete" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The process described/requested in the resource has been completed, and no further action is planned" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "inactive" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "inactive" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The resource describes information that is no longer valid or a process that is stopped occurring" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "abandoned" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "abandoned" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The process described/requested in the resource did not complete - usually due to some workflow error, and no further action is planned" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "unknown" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "unknown" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Authoring system does not know the status" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "unconfirmed" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "unconfirmed" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The information in this resource is not yet approved" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "confirmed" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "confirmed" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The information in this resource is approved" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "resolved" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "resolved" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The issue identified by this resource is no longer of concern" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "refuted" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "refuted" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "This information has been ruled out by testing and evaluation" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "differential" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "differential" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Potentially true?" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "partial" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "partial" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "This information is still being assembled" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "busy-unavailable" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "busy-unavailable" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "not available at this time/location" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "free" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "free" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Free for scheduling" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "on-target" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "on-target" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Ready to act" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "ahead-of-target" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "ahead-of-target" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Ahead of the planned timelines" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "behind-target" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "behind-target" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Behind the planned timelines" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "not-ready" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "not-ready" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Not ready to act" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "transduc-discon" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "transduc-discon" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The device transducer is disconnected" ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "hw-discon" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "hw-discon" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "The hardware is disconnected" ]
  ] .

# -------------------------------------------------------------------------------------


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.