### XML Procedure Example for TI Messenger API
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/pages/Procedure-ProcedureExample.xml.html
This snippet shows the structure of a Procedure example in XML format, as used by the TI Messenger API. It includes conditional logic based on artifact data.
```html
{% if 'xml' == 'xml' %} {% assign section = '7' %} {% elsif 'xml' == 'json' %} {% assign section = '8' %} {% else %} {% assign section = '9' %} {% endif %} {% include fragment-pagebegin.html %}
Publish Box goes here
{% include fragment-base-navtabs.html type='Procedure' id='ProcedureExample' active='xml' %} {% if site.data.artifacts\[page.path\].example %} {% assign example = 'Example ' %} {% endif %} {% assign prefix = site.data.artifacts\[page.path\].type %}
{{example}}{{prefix}}: {{site.data.pages\[page.path\].title | escape_once}}
----------------------------------------------------------------------------
{% include fragment-simpletable.html %}
[Raw xml](Procedure-ProcedureExample.xml) | [Download](Procedure-ProcedureExample.xml)
{% include fragment-intro.html type='Procedure' id='ProcedureExample' %} {% include Procedure-ProcedureExample-xml-html.xhtml %} {% include fragment-notes.html type='Procedure' id='ProcedureExample' %}
{% include fragment-pageend.html %}
```
--------------------------------
### Example and Prefix Variable Assignment (Liquid Template)
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/pages/Encounter-324534708.ttl.html
This code dynamically assigns an 'example' variable and a 'prefix' variable based on the presence of an example in the site data and the artifact type. This is used to construct titles and labels within the documentation.
```liquid
{% if site.data.artifacts[page.path].example %} {% assign example = 'Example ' %} {% endif %} {% assign prefix = site.data.artifacts[page.path].type %}
```
--------------------------------
### OpenAPI-Swagger Definition for Procedure Example
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/pages/Procedure-ProcedureExample.html
This snippet provides the raw OpenAPI-Swagger definition file for the Procedure Example. It details the API structure, endpoints, and data models. This definition is crucial for understanding and interacting with the API programmatically.
```json
{
"openapi": "3.0.0",
"info": {
"title": "Procedure Example API",
"version": "1.0.0",
"description": "Example OpenAPI definition for the Procedure API."
},
"paths": {
"/procedure": {
"get": {
"summary": "Get a list of procedures",
"responses": {
"200": {
"description": "A list of procedures."
}
}
}
}
}
}
```
--------------------------------
### JSON Implementation Guide Structure for CaseReference
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/ImplementationGuide-CaseReference-json-html.html
This snippet shows the core JSON structure for the CaseReference Implementation Guide. It includes metadata like version, status, publisher, and dependencies on other FHIR resources. It also defines various parameters for building and deploying the guide.
```json
{
"resourceType" : "ImplementationGuide",
"id" : "CaseReference",
"text" : {
"status" : "extensions",
"div" : "
CaseReference
The official URL for this implementation guide is:
http://gematik.de/fhir/TIM/CaseReference/ImplementationGuide/CaseReference
"
},
"url" : "http://gematik.de/fhir/TIM/CaseReference/ImplementationGuide/CaseReference",
"version" : "0.1.0",
"name" : "CaseReference",
"status" : "draft",
"date" : "2022-06-03T21:10:15+02:00",
"publisher" : "gematik GmbH",
"contact" : [
{
"name" : "gematik GmbH",
"telecom" : [
{
"system" : "url",
"value" : "www.gematik.de"
}
]
}
],
"packageId" : "CaseReference",
"license" : "CC0-1.0",
"fhirVersion" : [
"4.0.1"
],
"dependsOn" : [
{
"id" : "hl7tx",
"uri" : "http://terminology.hl7.org/ImplementationGuide/hl7.terminology",
"packageId" : "hl7.terminology.r4",
"version" : "3.1.0"
},
{
"id" : "de_basisprofil_r4",
"uri" : "http://fhir.org/packages/de.basisprofil.r4/ImplementationGuide/de.basisprofil.r4",
"packageId" : "de.basisprofil.r4",
"version" : "1.3.2"
}
],
"definition" : {
"extension" : [
{
"extension" : [
{
"url" : "code",
"valueString" : "copyrightyear"
},
{
"url" : "value",
"valueString" : "2022+"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "releaselabel"
},
{
"url" : "value",
"valueString" : "ci-build"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-liquid"
},
{
"url" : "value",
"valueString" : "template/liquid"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-liquid"
},
{
"url" : "value",
"valueString" : "input/liquid"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-qa"
},
{
"url" : "value",
"valueString" : "temp/qa"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-temp"
},
{
"url" : "value",
"valueString" : "temp/pages"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-output"
},
{
"url" : "value",
"valueString" : "output"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-suppressed-warnings"
},
{
"url" : "value",
"valueString" : "input/ignoreWarnings.txt"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "path-history"
},
{
"url" : "value",
"valueString" : "http://gematik.de/fhir/TIM/CaseReference/history.html"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
},
{
"extension" : [
{
"url" : "code",
"valueString" : "format-markdown"
},
{
"url" : "value",
"valueString" : "..."
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter"
}
]
}
}
```
--------------------------------
### FHIR Example Procedure Resource
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/ImplementationGuide-CaseReference-json-html.html
Presents an example FHIR Procedure resource, associated with the ProcedureCaseReference profile for TI-Messenger communication related to a patient's case reference. The example indicates the resource type as 'Procedure'.
```json
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString" : "Procedure"
}
],
"reference" : {
"reference" : "Procedure/ProcedureExample"
},
"name" : "ProcedureExample",
"description" : "An example of a encounter.",
"exampleCanonical" : "http://gematik.de/fhir/TIM/CaseReference/StructureDefinition/ProcedureCaseReference"
}
```
--------------------------------
### TTL Example for Procedure
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/pages/Procedure-ProcedureExample.ttl.html
This snippet shows an example of a procedure in Turtle (TTL) format. It utilizes Liquid templating for conditional includes and variable assignments.
```html
{% if 'ttl' == 'xml' %} {% assign section = '7' %} {% elsif 'ttl' == 'json' %} {% assign section = '8' %} {% else %} {% assign section = '9' %} {% endif %} {% include fragment-pagebegin.html %}
Publish Box goes here
{% include fragment-base-navtabs.html type='Procedure' id='ProcedureExample' active='ttl' %} {% if site.data.artifacts[page.path].example %} {% assign example = 'Example ' %} {% endif %} {% assign prefix = site.data.artifacts[page.path].type %}
{{example}}{{prefix}}: {{site.data.pages[page.path].title | escape_once}}
----------------------------------------------------------------------------
{% include fragment-simpletable.html %}
[Raw ttl](Procedure-ProcedureExample.ttl) | [Download](Procedure-ProcedureExample.ttl)
{% include fragment-intro.html type='Procedure' id='ProcedureExample' %} {% include Procedure-ProcedureExample-ttl-html.xhtml %} {% include fragment-notes.html type='Procedure' id='ProcedureExample' %}
{% include fragment-pageend.html %}
```
--------------------------------
### FHIR Example Condition Resource
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/ImplementationGuide-CaseReference-json-html.html
Provides an example FHIR Condition resource, linked to the ConditionCaseReference profile for TI-Messenger case reference communication. The example specifies the resource type as 'Condition'.
```json
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString" : "Condition"
}
],
"reference" : {
"reference" : "Condition/ConditionExample"
},
"name" : "ConditionExample",
"description" : "An example of a condition.",
"exampleCanonical" : "http://gematik.de/fhir/TIM/CaseReference/StructureDefinition/ConditionCaseReference"
}
```
--------------------------------
### FHIR Capability Statement Input Parameters
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/ImplementationGuide-CaseReference-json-html.html
Specifies input parameters for FHIR capability statements, indicating resource paths for capabilities and examples. These parameters guide the processing of FHIR resources.
```json
{
"code" : "path-resource",
"value" : "input/capabilities"
}
```
```json
{
"code" : "path-resource",
"value" : "input/examples"
}
```
--------------------------------
### FHIR Implementation Guide Parameters
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/ImplementationGuide-CaseReference-ttl-html.html
This snippet details the configuration parameters for an FHIR Implementation Guide. It specifies values for parameters like 'input/history', 'path-resource', 'path-pages', and 'path-tx-cache', which control resource generation, page templating, and terminology caching.
```turtle
fhir:ImplementationGuide.definition.parameter.value [ fhir:value "input/history" ] ],
[ fhir:index 11;
fhir:ImplementationGuide.definition.parameter.code [ fhir:value "path-resource" ];
fhir:ImplementationGuide.definition.parameter.value [ fhir:value "fsh-generated/resources" ] ],
[ fhir:index 12;
fhir:ImplementationGuide.definition.parameter.code [ fhir:value "path-pages" ];
fhir:ImplementationGuide.definition.parameter.value [ fhir:value "template/config" ] ],
[ fhir:index 13;
fhir:ImplementationGuide.definition.parameter.code [ fhir:value "path-pages" ];
fhir:ImplementationGuide.definition.parameter.value [ fhir:value "input/images" ] ],
[ fhir:index 14;
fhir:ImplementationGuide.definition.parameter.code [ fhir:value "path-tx-cache" ];
fhir:ImplementationGuide.definition.parameter.value [ fhir:value "input-cache/txcache" ] ]
```
--------------------------------
### JSON Condition Example Data
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/pages/Condition-ConditionExample.json.html
This snippet represents the raw JSON data for the Condition example. It's intended for direct use or download, serving as an example payload for the TI Messenger API. The exact structure and fields depend on the API's definition for 'Condition'.
```json
{% include Condition-ConditionExample-json-html.xhtml %}
```
--------------------------------
### Condition Example in TTL Format
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/pages/Condition-ConditionExample.ttl.html
This snippet demonstrates the structure of a condition example in TTL (Turtle) format. It is typically used for representing data in a human-readable and machine-readable way. No specific dependencies are mentioned, and the output is the TTL data itself.
```turtle
@prefix fhir: .
@prefix xsd: .
[
a fhir:Condition;
fhir:Condition.code [
a fhir:CodeableConcept;
fhir:CodeableConcept.coding [
a fhir:Coding;
fhir:Coding.code "12345"^^xsd:string;
fhir:Coding.display "Example Condition"
]
];
fhir:Condition.subject [
a fhir:Reference;
fhir:Reference.reference "Patient/example"
]
]
```
--------------------------------
### FHIR Example Encounter Resource
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/ImplementationGuide-CaseReference-json-html.html
Provides an example of a FHIR Encounter resource, linked to the EncounterCaseReference profile for TI-Messenger communication. The resource is identified by a specific ID and its type is 'Encounter'.
```json
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString" : "Encounter"
}
],
"reference" : {
"reference" : "Encounter/324534708"
},
"name" : "EncounterExample",
"description" : "An example of a encounter.",
"exampleCanonical" : "http://gematik.de/fhir/TIM/CaseReference/StructureDefinition/EncounterCaseReference"
}
```
--------------------------------
### FHIR Procedure Resource Definition (Turtle)
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/Procedure-ProcedureExample-ttl-html.html
Defines a FHIR Procedure resource in Turtle syntax. This example includes a specific profile (ProcedureCaseReference), an identifier, status, references to subject and encounter, and an annotation. It's used for representing a medical procedure within the FHIR standard.
```turtle
@prefix fhir: .
@prefix owl: .
@prefix rdfs: .
@prefix xsd: .
# - resource -------------------------------------------------------------------
a fhir:Procedure;
fhir:nodeRole fhir:treeRoot;
fhir:Resource.id [ fhir:value "ProcedureExample"];
fhir:Resource.meta [
fhir:Meta.profile [
fhir:value "http://gematik.de/fhir/TIM/CaseReference/StructureDefinition/ProcedureCaseReference";
fhir:index 0;
fhir:link
]
];
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "generated" ];
fhir:Narrative.div "Generated Narrative
identifier: id: ABC1234567890
status: preparation
subject: 374885372
encounter: 324534708
note: Additional information
"
];
fhir:Procedure.identifier [
fhir:index 0;
fhir:Identifier.system [ fhir:value "http://example.de/StructureDefinition/identifier-interne-abrechnungsnummer" ];
fhir:Identifier.value [ fhir:value "ABC1234567890" ]
];
fhir:Procedure.status [ fhir:value "preparation"];
fhir:Procedure.subject [
fhir:Reference.reference [ fhir:value "374885372" ]
];
fhir:Procedure.encounter [
fhir:Reference.reference [ fhir:value "324534708" ]
];
fhir:Procedure.note [
fhir:index 0;
fhir:Annotation.text [ fhir:value "Additional information" ]
].
# - ontology header ------------------------------------------------------------
a owl:Ontology;
owl:imports fhir:fhir.ttl.
```
--------------------------------
### HTML Snippet for Condition Example
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/pages/Condition-ConditionExample.json.html
This HTML snippet is part of the Condition example within the TI Messenger API. It is likely used to render or display JSON data in an HTML context. No specific inputs or outputs are detailed, but it relies on the Liquid templating engine.
```html
{% include fragment-simpletable.html %}
[Raw json](Condition-ConditionExample.json) | [Download](Condition-ConditionExample.json)
{% include fragment-intro.html type='Condition' id='ConditionExample' %} {% include Condition-ConditionExample-json-html.xhtml %} {% include fragment-notes.html type='Condition' id='ConditionExample' %}
```
--------------------------------
### Procedure Terminology Bindings
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/StructureDefinition-ProcedureCaseReference-tx.html
Details the terminology bindings for different elements within the FHIR Procedure resource, including required, preferred, and example bindings to various ValueSets.
```APIDOC
## Procedure Terminology Bindings
This section outlines the terminology bindings for elements within the FHIR Procedure resource.
### Procedure.language
* **Binding Type**: Preferred
* **ValueSet**: [CommonLanguages](http://hl7.org/fhir/R4/valueset-languages.html)
* **Max Value Set**: [AllLanguages](http://hl7.org/fhir/R4/valueset-all-languages.html)
### Procedure.status
* **Binding Type**: Required
* **ValueSet**: [EventStatus](http://hl7.org/fhir/R4/valueset-event-status.html)
### Procedure.statusReason
* **Binding Type**: Example
* **ValueSet**: [ProcedureNotPerformedReason(SNOMED-CT)](http://hl7.org/fhir/R4/valueset-procedure-not-performed-reason.html)
### Procedure.category
* **Binding Type**: Example
* **ValueSet**: [ProcedureCategoryCodes(SNOMEDCT)](http://hl7.org/fhir/R4/valueset-procedure-category.html)
### Procedure.code
* **Binding Type**: Example
* **ValueSet**: [ProcedureCodes(SNOMEDCT)](http://hl7.org/fhir/R4/valueset-procedure-code.html)
### Procedure.performer.function
* **Binding Type**: Example
* **ValueSet**: [ProcedurePerformerRoleCodes](http://hl7.org/fhir/R4/valueset-performer-role.html)
### Procedure.reasonCode
* **Binding Type**: Example
* **ValueSet**: [ProcedureReasonCodes](http://hl7.org/fhir/R4/valueset-procedure-reason.html)
### Procedure.bodySite
* **Binding Type**: Example
* **ValueSet**: [SNOMEDCTBodyStructures](http://hl7.org/fhir/R4/valueset-body-site.html)
### Procedure.outcome
* **Binding Type**: Example
* **ValueSet**: [ProcedureOutcomeCodes(SNOMEDCT)](http://hl7.org/fhir/R4/valueset-procedure-outcome.html)
### Procedure.complication
* **Binding Type**: Example
* **ValueSet**: [Condition/Problem/DiagnosisCodes](http://hl7.org/fhir/R4/valueset-condition-code.html)
### Procedure.followUp
* **Binding Type**: Example
* **ValueSet**: [ProcedureFollowUpCodes(SNOMEDCT)](http://hl7.org/fhir/R4/valueset-procedure-followup.html)
### Procedure.focalDevice.action
* **Binding Type**: Preferred
* **ValueSet**: [ProcedureDeviceActionCodes](http://hl7.org/fhir/R4/valueset-device-action.html)
### Procedure.usedCode
* **Binding Type**: Example
* **ValueSet**: [FHIRDeviceTypes](http://hl7.org/fhir/R4/valueset-device-kind.html)
```
--------------------------------
### Encounter.classHistory
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/StructureDefinition-EncounterCaseReference-dict.html
The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.
```APIDOC
## Encounter.classHistory
### Description
Tracks encounter transitions without resource history, useful for scenarios like emergency to inpatient transitions to maintain data continuity.
### Method
N/A (This is a structural definition, not an endpoint)
### Endpoint
N/A
### Parameters
#### Path Parameters
None
#### Query Parameters
None
#### Request Body
- **id** (string) - Optional - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- **extension** (Extension) - Optional - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- **modifierExtension** (Extension) - Optional - May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
### Request Example
```json
{
"id": "example-id",
"extension": [
{
"url": "http://example.com/fhir/StructureDefinition/example-extension",
"valueString": "additional info"
}
],
"modifierExtension": [
{
"url": "http://example.com/fhir/StructureDefinition/example-modifier-extension",
"valueBoolean": true
}
]
}
```
### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the element.
- **extension** (Extension) - Additional information not part of the basic definition.
- **modifierExtension** (Extension) - Modifies the understanding of the element.
#### Response Example
```json
{
"id": "example-id",
"extension": [
{
"url": "http://example.com/fhir/StructureDefinition/example-extension",
"valueString": "additional info"
}
],
"modifierExtension": [
{
"url": "http://example.com/fhir/StructureDefinition/example-modifier-extension",
"valueBoolean": true
}
]
}
```
**Invariants:**
- **ele-1**: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
```
--------------------------------
### Encounter.classHistory
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/StructureDefinition-EncounterCaseReference-dict-active.html
The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.
```APIDOC
## Encounter.classHistory
### Description
Tracks encounter transitions without needing resource history, allowing continuity of patient data across changes like emergency to inpatient admissions.
### Type
BackboneElement
### Control
0..*
### Must Support
True
### Invariants
- **ele-1**: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
```
--------------------------------
### FHIR Implementation Guide Page: Home
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/ImplementationGuide-CaseReference-ttl-html.html
Defines a FHIR ImplementationGuide page for the Home section, specifying its name, title, and generation type as Markdown.
```turtle
fhir:ImplementationGuide.definition.page.page [
fhir:index 0;
fhir:ImplementationGuide.definition.page.nameUrl [ fhir:value "index.html" ];
fhir:ImplementationGuide.definition.page.title [ fhir:value "Home" ];
fhir:ImplementationGuide.definition.page.generation [ fhir:value "markdown" ]
]
```
--------------------------------
### FHIR Example Patient Resource
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/ImplementationGuide-CaseReference-json-html.html
Presents an example FHIR Patient resource, associated with the PatientCaseReference profile for TI-Messenger communication. The example includes a specific patient ID and indicates the resource type is 'Patient'.
```json
{
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/resource-information",
"valueString" : "Patient"
}
],
"reference" : {
"reference" : "Patient/374885372"
},
"name" : "PatientExample",
"description" : "An example of a patient.",
"exampleCanonical" : "http://gematik.de/fhir/TIM/CaseReference/StructureDefinition/PatientCaseReference"
}
```
--------------------------------
### FHIR ImplementationGuide for CaseReference (Turtle)
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/ImplementationGuide-CaseReference-ttl-html.html
This code snippet defines a FHIR ImplementationGuide resource in Turtle format. It includes metadata such as URL, version, status, publisher, and contact information. It also specifies dependencies on other FHIR implementation guides and configuration parameters for the build process.
```Turtle
@prefix fhir: .
@prefix owl: .
@prefix rdfs: .
@prefix xsd: .
# - resource -------------------------------------------------------------------
a fhir:ImplementationGuide;
fhir:nodeRole fhir:treeRoot;
fhir:Resource.id [ fhir:value "CaseReference"];
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "extensions" ];
fhir:Narrative.div "CaseReference
The official URL for this implementation guide is:
http://gematik.de/fhir/TIM/CaseReference/ImplementationGuide/CaseReference
"
];
fhir:ImplementationGuide.url [ fhir:value "http://gematik.de/fhir/TIM/CaseReference/ImplementationGuide/CaseReference"];
fhir:ImplementationGuide.version [ fhir:value "0.1.0"];
fhir:ImplementationGuide.name [ fhir:value "CaseReference"];
fhir:ImplementationGuide.status [ fhir:value "draft"];
fhir:ImplementationGuide.date [ fhir:value "2022-06-03T21:10:15+02:00"^^xsd:dateTime];
fhir:ImplementationGuide.publisher [ fhir:value "gematik GmbH"];
fhir:ImplementationGuide.contact [
fhir:index 0;
fhir:ContactDetail.name [ fhir:value "gematik GmbH" ];
fhir:ContactDetail.telecom [
fhir:index 0;
fhir:ContactPoint.system [ fhir:value "url" ];
fhir:ContactPoint.value [ fhir:value "www.gematik.de" ] ]
];
fhir:ImplementationGuide.packageId [ fhir:value "CaseReference"];
fhir:ImplementationGuide.license [ fhir:value "CC0-1.0"];
fhir:ImplementationGuide.fhirVersion [
fhir:value "4.0.1";
fhir:index 0
];
fhir:ImplementationGuide.dependsOn [
fhir:index 0;
fhir:Element.id [ fhir:value "hl7tx" ];
fhir:ImplementationGuide.dependsOn.uri [
fhir:value "http://terminology.hl7.org/ImplementationGuide/hl7.terminology";
fhir:link
];
fhir:ImplementationGuide.dependsOn.packageId [ fhir:value "hl7.terminology.r4" ];
fhir:ImplementationGuide.dependsOn.version [ fhir:value "3.1.0" ]
], [
fhir:index 1;
fhir:Element.id [ fhir:value "de_basisprofil_r4" ];
fhir:ImplementationGuide.dependsOn.uri [
fhir:value "http://fhir.org/packages/de.basisprofil.r4/ImplementationGuide/de.basisprofil.r4";
fhir:link
];
fhir:ImplementationGuide.dependsOn.packageId [ fhir:value "de.basisprofil.r4" ];
fhir:ImplementationGuide.dependsOn.version [ fhir:value "1.3.2" ]
];
fhir:ImplementationGuide.definition [
fhir:Element.extension [
fhir:index 0;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "code" ];
fhir:Extension.valueString [ fhir:value "copyrightyear" ] ],
[
fhir:index 1;
fhir:Extension.url [ fhir:value "value" ];
fhir:Extension.valueString [ fhir:value "2022+" ] ];
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" ] ],
[
fhir:index 1;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "code" ];
fhir:Extension.valueString [ fhir:value "releaselabel" ] ],
[
fhir:index 1;
fhir:Extension.url [ fhir:value "value" ];
fhir:Extension.valueString [ fhir:value "ci-build" ] ];
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" ] ],
[
fhir:index 2;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "code" ];
fhir:Extension.valueString [ fhir:value "path-liquid" ] ],
[
fhir:index 1;
fhir:Extension.url [ fhir:value "value" ];
fhir:Extension.valueString [ fhir:value "template/liquid" ] ];
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" ] ],
[
fhir:index 3;
fhir:Element.extension [
fhir:index 0;
fhir:Extension.url [ fhir:value "code" ];
fhir:Extension.valueString [ fhir:value "path-liquid" ] ],
[
fhir:index 1;
fhir:Extension.url [ fhir:value "value" ];
fhir:Extension.valueString [ fhir:value "input/liquid" ] ];
```
--------------------------------
### FHIR Procedure Resource (HTML) - Gematik API TI Messenger
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/qa/Procedure-ProcedureExample-json-html.html
This snippet demonstrates how a FHIR Procedure resource can be rendered in HTML for display. It includes a generated narrative that summarizes key information like the identifier, status, subject, encounter, and notes, making it human-readable.
```html
Generated Narrative
identifier: id: ABC1234567890
status: preparation
subject: 374885372
encounter: 324534708
note: Additional information
```
--------------------------------
### Patient Resource JSON Example
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/pages/Patient-374885372.json.html
This snippet shows an example of the Patient resource in JSON format. It is used to represent patient data within the API TI Messenger system. No external dependencies are required to interpret this JSON structure.
```json
{
"resourceType": "Patient",
"id": "374885372",
"meta": {
"profile": [
"https://gematik.de/fhir/StructureDefinition/telematik/StructureDefinition/messaging/StructureDefinition/Practitioner"
]
},
"identifier": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical Record Number"
}
]
},
"system": "urn:oid:2.16.840.1.113883.3.34.2.4.4.1.1.2",
"value": "123456789"
}
],
"active": true,
"name": [
{
"use": "official",
"family": "Musterfrau",
"given": [
"Erika"
]
}
],
"telecom": [
{
"system": "phone",
"value": "03012345678",
"use": "work"
},
{
"system": "email",
"value": "erika.musterfrau@beispiel.de",
"use": "work"
}
],
"gender": "female",
"birthDate": "1980-05-15",
"deceasedBoolean": false,
"address": [
{
"use": "home",
"line": [
"Musterstraße 1"
],
"city": "Musterstadt",
"postalCode": "12345",
"country": "DE"
}
],
"maritalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "S",
"display": "Single"
}
]
},
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "de-DE",
"display": "German"
}
]
},
"preferred": true
}
]
}
```
--------------------------------
### Liquid Templating for Artifact and Page Data
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/temp/pages/Condition-ConditionExample.json.html
This Liquid code snippet retrieves and assigns artifact and page data, potentially for display purposes on a web page. It checks for the existence of an 'example' in the site's data and constructs a 'prefix' based on the artifact type. This is typical for dynamic content generation in static site frameworks.
```liquid
{% include fragment-base-navtabs.html type='Condition' id='ConditionExample' active='json' %} {% if site.data.artifacts[page.path].example %} {% assign example = 'Example ' %} {% endif %} {% assign prefix = site.data.artifacts[page.path].type %}
{{example}}{{prefix}}: {{site.data.pages[page.path].title | escape_once}}
```
--------------------------------
### ProcedureExample Resource - XML Representation
Source: https://github.com/gematik/api-ti-messenger/blob/main/src/fhir/output/Procedure-ProcedureExample.xml.html
This section provides the XML representation of the ProcedureExample resource, conforming to FHIR v4.0.1 standards and the specific profile for CaseReference.
```APIDOC
## GET /gematik/api-ti-messenger/ProcedureExample
### Description
Retrieves the XML representation of the ProcedureExample resource.
### Method
GET
### Endpoint
/gematik/api-ti-messenger/ProcedureExample
### Parameters
#### Query Parameters
None
#### Request Body
None
### Request Example
None
### Response
#### Success Response (200)
- **content** (string) - The XML content of the ProcedureExample resource.
#### Response Example
```xml
Generated Narrative
identifier: id: ABC1234567890
status: preparation
subject: 374885372
encounter: 324534708
note: Additional information
```
```