Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU 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

Codesystem-restful-interaction.ttl

Example CodeSystem/restful-interaction (Turtle)

FHIR Infrastructure Work Group Maturity Level : N/A Standards Status : Informative

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

Definition for Code SystemFHIR Restful Interactions 

@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 "restful-interaction"];
  fhir:Resource.meta [
     fhir:Meta.lastUpdated [ fhir:value "2022-05-28T13:47:40.239+11:00" ]

     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:index 0;

     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" ];
     fhir:Extension.value [ fhir:value "fhir" ]
  ], [
     fhir:index 1;

     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ];
     fhir:Extension.value [ fhir:value "normative" ]
  ], [
     fhir:index 2;

     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ];
     fhir:Extension.value [ fhir:value "4.0.0" ]
  ], [
     fhir:index 3;

     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/restful-interaction"];
  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.1823" ]
  ];
  fhir:CanonicalResource.version [ fhir:value "5.0.0-ballot"];
  fhir:CanonicalResource.name [ fhir:value "FHIR Restful Interactions"];
  fhir:CanonicalResource.status [ fhir:value "active"];
  fhir:CanonicalResource.experimental [ fhir:value "false"];
  fhir:CanonicalResource.publisher [ fhir:value "FHIR Project"];
  fhir:CanonicalResource.description [ fhir:value "The set of interactions defined by the RESTful part of the FHIR specification."];

  fhir:CodeSystem.url [ fhir:value "http://hl7.org/fhir/restful-interaction"];
  fhir:CodeSystem.version [ fhir:value "4.3.0"];

  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.1823" ]
  ];
  fhir:CodeSystem.version [ fhir:value "5.0.0-ballot"];

  fhir:CodeSystem.name [ fhir:value "FHIR Restful Interactions"];
  fhir:CodeSystem.status [ fhir:value "active"];
  fhir:CodeSystem.experimental [ fhir:value "false"];
  fhir:CodeSystem.publisher [ fhir:value "FHIR Project"];
  fhir:CodeSystem.description [ fhir:value "The set of interactions defined by the RESTful part of the FHIR specification."];
  fhir:CodeSystem.caseSensitive [ fhir:value "true"];
  fhir:CodeSystem.valueSet [ fhir:value "http://hl7.org/fhir/ValueSet/restful-interaction"];
  fhir:CodeSystem.hierarchyMeaning [ fhir:value "is-a"];
  fhir:CodeSystem.content [ fhir:value "complete"];
  fhir:CodeSystem.concept [
     fhir:index 0;
     fhir:CodeSystem.code [ fhir:value "read" ];
     fhir:CodeSystem.display [ fhir:value "read" ];
     fhir:CodeSystem.definition [ fhir:value "Read the current state of the resource." ]

     fhir:ConceptDefinitionComponent.code [ fhir:value "read" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "read" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Read the current state of the resource." ]

  ], [
     fhir:index 1;
     fhir:CodeSystem.code [ fhir:value "vread" ];
     fhir:CodeSystem.display [ fhir:value "vread" ];
     fhir:CodeSystem.definition [ fhir:value "Read the state of a specific version of the resource." ]

     fhir:ConceptDefinitionComponent.code [ fhir:value "vread" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "vread" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Read the state of a specific version of the resource." ]

  ], [
     fhir:index 2;
     fhir:CodeSystem.code [ fhir:value "update" ];
     fhir:CodeSystem.display [ fhir:value "update" ];
     fhir:CodeSystem.definition [ fhir:value "Update an existing resource by its id (or create it if it is new)." ]

     fhir:ConceptDefinitionComponent.code [ fhir:value "update" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "update" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Update an existing resource by its id (or create it if it is new)." ]

  ], [
     fhir:index 3;
     fhir:CodeSystem.code [ fhir:value "patch" ];
     fhir:CodeSystem.display [ fhir:value "patch" ];
     fhir:CodeSystem.definition [ fhir:value "Update an existing resource by posting a set of changes to it." ]

     fhir:ConceptDefinitionComponent.code [ fhir:value "patch" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "patch" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Update an existing resource by posting a set of changes to it." ]

  ], [
     fhir:index 4;
     fhir:CodeSystem.code [ fhir:value "delete" ];
     fhir:CodeSystem.display [ fhir:value "delete" ];
     fhir:CodeSystem.definition [ fhir:value "Delete a resource." ]

     fhir:ConceptDefinitionComponent.code [ fhir:value "delete" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "delete" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Delete a resource." ]

  ], [
     fhir:index 5;
     fhir:CodeSystem.code [ fhir:value "history" ];
     fhir:CodeSystem.display [ fhir:value "history" ];
     fhir:CodeSystem.definition [ fhir:value "Retrieve the change history for a particular resource, type of resource, or the entire system." ];
     fhir:CodeSystem.concept [
       fhir:index 0;
       fhir:CodeSystem.code [ fhir:value "history-instance" ];
       fhir:CodeSystem.display [ fhir:value "history-instance" ];
       fhir:CodeSystem.definition [ fhir:value "Retrieve the change history for a particular resource." ]

     fhir:ConceptDefinitionComponent.code [ fhir:value "history" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "history" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Retrieve the change history for a particular resource, type of resource, or the entire system." ];
     fhir:ConceptDefinitionComponent.concept [
       fhir:ConceptDefinitionComponent.code [ fhir:value "history-instance" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "history-instance" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "Retrieve the change history for a particular resource." ]

     ], [
       fhir:index 1;
       fhir:CodeSystem.code [ fhir:value "history-type" ];
       fhir:CodeSystem.display [ fhir:value "history-type" ];
       fhir:CodeSystem.definition [ fhir:value "Retrieve the change history for all resources of a particular type." ]

       fhir:ConceptDefinitionComponent.code [ fhir:value "history-type" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "history-type" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "Retrieve the change history for all resources of a particular type." ]

     ], [
       fhir:index 2;
       fhir:CodeSystem.code [ fhir:value "history-system" ];
       fhir:CodeSystem.display [ fhir:value "history-system" ];
       fhir:CodeSystem.definition [ fhir:value "Retrieve the change history for all resources on a system." ]

       fhir:ConceptDefinitionComponent.code [ fhir:value "history-system" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "history-system" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "Retrieve the change history for all resources on a system." ]

     ]
  ], [
     fhir:index 6;
     fhir:CodeSystem.code [ fhir:value "create" ];
     fhir:CodeSystem.display [ fhir:value "create" ];
     fhir:CodeSystem.definition [ fhir:value "Create a new resource with a server assigned id." ]

     fhir:ConceptDefinitionComponent.code [ fhir:value "create" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "create" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Create a new resource with a server assigned id." ]

  ], [
     fhir:index 7;
     fhir:CodeSystem.code [ fhir:value "search" ];
     fhir:CodeSystem.display [ fhir:value "search" ];
     fhir:CodeSystem.definition [ fhir:value "Search a resource type or all resources based on some filter criteria." ];
     fhir:CodeSystem.concept [
       fhir:index 0;
       fhir:CodeSystem.code [ fhir:value "search-type" ];
       fhir:CodeSystem.display [ fhir:value "search-type" ];
       fhir:CodeSystem.definition [ fhir:value "Search all resources of the specified type based on some filter criteria." ]

     fhir:ConceptDefinitionComponent.code [ fhir:value "search" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "search" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Search a resource type or all resources based on some filter criteria." ];
     fhir:ConceptDefinitionComponent.concept [
       fhir:ConceptDefinitionComponent.code [ fhir:value "search-type" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "search-type" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "Search all resources of the specified type based on some filter criteria." ]

     ], [
       fhir:index 1;
       fhir:CodeSystem.code [ fhir:value "search-system" ];
       fhir:CodeSystem.display [ fhir:value "search-system" ];
       fhir:CodeSystem.definition [ fhir:value "Search all resources based on some filter criteria." ]

       fhir:ConceptDefinitionComponent.code [ fhir:value "search-system" ];
       fhir:ConceptDefinitionComponent.display [ fhir:value "search-system" ];
       fhir:ConceptDefinitionComponent.definition [ fhir:value "Search all resources based on some filter criteria." ]

     ]
  ], [
     fhir:index 8;
     fhir:CodeSystem.code [ fhir:value "capabilities" ];
     fhir:CodeSystem.display [ fhir:value "capabilities" ];
     fhir:CodeSystem.definition [ fhir:value "Get a Capability Statement for the system." ]

     fhir:ConceptDefinitionComponent.code [ fhir:value "capabilities" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "capabilities" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Get a Capability Statement for the system." ]

  ], [
     fhir:index 9;
     fhir:CodeSystem.code [ fhir:value "transaction" ];
     fhir:CodeSystem.display [ fhir:value "transaction" ];
     fhir:CodeSystem.definition [ fhir:value "Update, create or delete a set of resources as a single transaction." ]

     fhir:ConceptDefinitionComponent.code [ fhir:value "transaction" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "transaction" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Update, create or delete a set of resources as a single transaction." ]

  ], [
     fhir:index 10;
     fhir:CodeSystem.code [ fhir:value "batch" ];
     fhir:CodeSystem.display [ fhir:value "batch" ];
     fhir:CodeSystem.definition [ fhir:value "perform a set of a separate interactions in a single http operation" ]

     fhir:ConceptDefinitionComponent.code [ fhir:value "batch" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "batch" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "perform a set of a separate interactions in a single http operation" ]

  ], [
     fhir:index 11;
     fhir:CodeSystem.code [ fhir:value "operation" ];
     fhir:CodeSystem.display [ fhir:value "operation" ];
     fhir:CodeSystem.definition [ fhir:value "Perform an operation as defined by an OperationDefinition." ]

     fhir:ConceptDefinitionComponent.code [ fhir:value "operation" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "operation" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Perform an operation as defined by an OperationDefinition." ]

  ] .

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

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.