HL7 FHIR R4

https://hl7.org/fhir/R4
Admin
FHIR (Fast Healthcare Interoperability Resources) is a standard for exchanging healthcare...
Tokens:640,110
Snippets:2,348
Trust Score:9.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET /ImplementationGuide

Source: https://hl7.org/fhir/R4/implementationguide.html

Search for ImplementationGuide resources using resource-specific search parameters. Standard search parameters can be provided as query parameters to filter matching resources.

```APIDOC
## GET /ImplementationGuide

### Description
Search for ImplementationGuide resources using specific search query parameters.

### Method
GET

### Endpoint
/ImplementationGuide

### Parameters
#### Query Parameters
- **context** (token) - Optional - A use context assigned to the implementation guide
- **context-quantity** (quantity) - Optional - A quantity- or range-valued use context assigned to the implementation guide
- **context-type** (token) - Optional - A type of use context assigned to the implementation guide
- **context-type-quantity** (composite) - Optional - A use context type and quantity- or range-based value assigned to the implementation guide
- **context-type-value** (composite) - Optional - A use context type and value assigned to the implementation guide
- **date** (date) - Optional - The implementation guide publication date
- **depends-on** (reference) - Optional - Identity of the IG that this depends on
- **description** (string) - Optional - The description of the implementation guide
- **experimental** (token) - Optional - For testing purposes, not real usage
- **global** (reference) - Optional - Profile that all resources must conform to
- **jurisdiction** (token) - Optional - Intended jurisdiction for the implementation guide
- **name** (string) - Optional - Computationally friendly name of the implementation guide
- **publisher** (string) - Optional - Name of the publisher of the implementation guide
- **resource** (reference) - Optional - Location of the resource
- **status** (token) - Optional - The current status of the implementation guide
- **title** (string) - Optional - The human-friendly name of the implementation guide
- **url** (uri) - Optional - The uri that identifies the implementation guide
- **version** (token) - Optional - The business version of the implementation guide
```

--------------------------------

### Example Location Hierarchy Structure

Source: https://hl7.org/fhir/R4/location.html

Illustrates an example nesting hierarchy representing the part-of structure of physical and mobile locations in a facility.

```text
Hospital A Building C (instance)
    East Wing (instance)
        Level 1 (instance)
            Reception (instance)
            Nurses Station EM-ns1 (instance)
                Medication Cupboard A (instance)
            Room 1 (instance)
                Room 1a (instance) - space in room separatable via a curtain
                    Bed 1a (instance) - always in this room
                Room 1b (instance)
                    Trolley 43 (instance) - moves about
                Room 1d (instance)
                    Trolley 19 (instance) - moves about
                Room 2 (instance)
                    ...
            Theatre EM-TA (instance)
            Coridor (generic)
        Level 2 (instance)
            Reception (instance)
                ...
            Nurses Station EM-ns1 (instance)
                Medication Cupboard A (instance)
            Coridor (generic)
Mobile Services (kind)
    Ambulance (kind)
        Ambulance AMB1 (instance)
        Ambulance AMB2 (instance)
	
```

--------------------------------

### Validate code and system against a known ValueSet with GET

Source: https://hl7.org/fhir/R4/terminology-service.html

Perform simple validation of a code and system directly against an existing ValueSet resource using an HTTP GET request.

```http
GET [base]/ValueSet/23/$validate-code?system=http://loinc.org&code=1963-8&display=test

```

--------------------------------

### Initialize a closure table with ConceptMap/$closure

Source: https://hl7.org/fhir/R4/terminology-service.html

POST these Parameters to [base]/ConceptMap/$closure to initialize a closure table before use. A successful initialization returns a 200 OK with the created ConceptMap resource.

```json
{
  "resourceType" : "Parameters",
   "parameter" : [{
     "name" : "name",
     "valueString" : "[name]"
  }]
}

```

```json
{
    "resourceType": "ConceptMap",
    "id": "[name]",
    "version": "0",
    "name": "Closure Table [name] Creation",
    "status": "active",
    "experimental": true,
    "date": "2015-12-20T23:10:55Z"
}

```

--------------------------------

### Define ImplementationGuide Resource Structure in XML

Source: https://hl7.org/fhir/R4/implementationguide.html

XML template illustrating the structure, elements, and cardinalities of an ImplementationGuide resource.

```xml
<**ImplementationGuide** xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <**url** value="[uri]"/><!-- **1..1** Canonical identifier for this implementation guide, represented as a URI (globally unique) -->
 <**version** value="[string]"/><!-- **0..1** Business version of the implementation guide -->
 <**name** value="[string]"/><!-- **** Name for this implementation guide (computer friendly) -->
 <**title** value="[string]"/><!-- **0..1** Name for this implementation guide (human friendly) -->
 <**status** value="[code]"/><!-- **1..1** draft | active | retired | unknown -->
 <**experimental** value="[boolean]"/><!-- **0..1** For testing purposes, not real usage -->
 <**date** value="[dateTime]"/><!-- **0..1** Date last changed -->
 <**publisher** value="[string]"/><!-- **0..1** Name of the publisher (organization or individual) -->
 <**contact**><!-- **0..*** ContactDetail Contact details for the publisher --></contact>
 <**description** value="[markdown]"/><!-- **0..1** Natural language description of the implementation guide -->
 <**useContext**><!-- **0..*** UsageContext The context that the content is intended to support --></useContext>
 <**jurisdiction**><!-- **0..*** CodeableConcept Intended jurisdiction for implementation guide (if applicable) --></jurisdiction>
 <**copyright** value="[markdown]"/><!-- **0..1** Use and/or publishing restrictions -->
 <**packageId** value="[id]"/><!-- **1..1** NPM Package name for IG -->
 <**license** value="[code]"/><!-- **0..1** SPDX license code for this IG (or not-open-source) -->
 <**fhirVersion** value="[code]"/><!-- **1..*** FHIR Version(s) this Implementation Guide targets -->
 <**dependsOn**>  <!-- **0..*** Another Implementation guide this depends on -->
  <**uri**><!-- **1..1** canonical(ImplementationGuide) Identity of the IG that this depends on --></uri>
  <**packageId** value="[id]"/><!-- **0..1** NPM Package name for IG this depends on -->
  <**version** value="[string]"/><!-- **0..1** Version of the IG -->
 </dependsOn>
 <**global**>  <!-- **0..*** Profiles that apply globally -->
  <**type** value="[code]"/><!-- **1..1** Type this profile applies to -->
  <**profile**><!-- **1..1** canonical(StructureDefinition) Profile that all resources must conform to --></profile>
 </global>
 <**definition**>  <!-- **0..1** Information needed to build the IG -->
  <**grouping**>  <!-- **0..*** Grouping used to present related resources in the IG -->
   <**name** value="[string]"/><!-- **1..1** Descriptive name for the package -->
   <**description** value="[string]"/><!-- **0..1** Human readable text describing the package -->
  </grouping>
  <**resource**>  <!-- **1..*** Resource in the implementation guide -->
   <**reference**><!-- **1..1** Reference(Any) Location of the resource --></reference>
   <**fhirVersion** value="[code]"/><!-- **0..*** Versions this applies to (if different to IG) -->
   <**name** value="[string]"/><!-- **0..1** Human Name for the resource -->
   <**description** value="[string]"/><!-- **0..1** Reason why included in guide -->
   <**example[x]**><!-- **0..1** boolean|canonical(StructureDefinition) Is an example/What is this an example of? --></example[x]>
   <**groupingId** value="[id]"/><!-- **0..1** Grouping this is part of -->
  </resource>
  <**page**>  <!-- **0..1** Page/Section in the Guide -->
   <**name[x]**><!-- **1..1** url|Reference(Binary) Where to find that page --></name[x]>
   <**title** value="[string]"/><!-- **1..1** Short title shown for navigational assistance -->
   <**generation** value="[code]"/><!-- **1..1** html | markdown | xml | generated -->
   <**page**><!-- **0..*** Content as for ImplementationGuide.definition.page Nested Pages / Sections --></page>
  </page>
  <**parameter**>  <!-- **0..*** Defines how IG is built by tools -->
```

--------------------------------

### Perform subsumption testing via GET with codes

Source: https://hl7.org/fhir/R4/terminology-service.html

Tests whether a SNOMED CT Concept subsumes another concept using simple query parameters in a GET request.

```http
GET [base]/CodeSystem/$subsumes?system=http://snomed.info/sct&codeA=235856003&codeB=3738000

```

--------------------------------

### GET ?

Source: https://hl7.org/fhir/R4/http.html

Performs a system-wide search across all resource types. Returns a Bundle containing the matching resources across all types.

```APIDOC
## GET ?

### Description
System-wide search interaction (search-all) across all resource types.

### Method
GET

### Endpoint
`?`

### Parameters
#### Headers
- **Accept** (string) - Optional - Indicates the response format.

### Response
#### Success Response (200)
- **Body** (Bundle) - Required - A Bundle containing matching search results.

#### Status Codes
- `200`
- `401`
```

--------------------------------

### Lookup Code via CodeSystem Canonical URL and Properties with GET

Source: https://hl7.org/fhir/R4/terminology-service.html

Performs a more reliable GET $lookup query using the canonical system URL and specific requested property parameters.

```http
GET [base]/CodeSystem/$lookup?system=http://loinc.org&code=1963-8&property=code&property=display&property=designations

```

--------------------------------

### GET /CodeSystem/$subsumes

Source: https://hl7.org/fhir/R4/terminology-service.html

Tests the subsumption relationship between two codes or Codings within a specified CodeSystem using HTTP GET. Returns an outcome code indicating equivalence, subsumption, or no subsumption relationship.

```APIDOC
## GET /CodeSystem/$subsumes

### Description
Tests the subsumption relationship between concept A and concept B based on the CodeSystem definition of subsumption.

### Method
GET

### Endpoint
`[base]/CodeSystem/$subsumes`

### Parameters
#### Query Parameters
- **system** (uri) - Required - The system that identifies the code system in which subsumption testing is to be performed.
- **codeA** (code) - Optional - Concept A as a code.
- **codeB** (code) - Optional - Concept B as a code.
- **version** (string) - Optional - The version of the code system to use.

### Request Example
```http
GET [base]/CodeSystem/$subsumes?system=http://snomed.info/sct&codeA=235856003&codeB=3738000
```

### Response
#### Success Response (200 OK)
- **resourceType** (string) - Parameters
- **parameter** (array) - List of parameters containing the outcome code (`equivalent`, `subsumes`, `subsumed-by`, or `not-subsumed`).

#### Response Example
```json
{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "outcome",
      "valueCode": "subsumes"
    }
  ]
}
```
```

--------------------------------

### $meta-add

Source: https://hl7.org/fhir/R4/operationslist.html

Add profiles, tags, and security labels to an existing resource instance.

```APIDOC
### Endpoints
- `[base]/[Resource]/[id]/$meta-add`

### Description
Add profiles, tags, and security labels to a resource.
```

--------------------------------

### POST /

Source: https://hl7.org/fhir/R4/http.html

Executes a transaction or batch interaction by submitting a Bundle containing multiple interaction entries to the server root.

```APIDOC
## POST /

### Description
Transaction interaction to process a Bundle of actions.

### Method
POST

### Endpoint
`/`

### Parameters
#### Headers
- **Content-Type** (string) - Required - Content-type of the bundle.
- **Prefer** (string) - Optional - Preference header.
- **Accept** (string) - Optional - Indicates the response format.

#### Request Body
- **Bundle** - Required - A Bundle containing interaction requests.

### Response
#### Success Response (200)
- **Body** (Bundle) - Required - A Bundle containing interaction responses.

#### Status Codes
- `200`
- `400`
- `404`
- `405`
- `409`
- `412`
- `422`
```

--------------------------------

### Lookup Code via CodeSystem Logical ID with GET

Source: https://hl7.org/fhir/R4/terminology-service.html

Performs a GET $lookup operation on a CodeSystem instance using a logical id. Logical IDs may not be consistent across different servers.

```http
GET [base]/CodeSystem/loinc/$lookup?code=1963-8

```
Tokens:
Raw