Implementation Guide
TI Common
Version 1.5.0-ballot.1 - ballot

Extension: HTTP-Antwortinformationen

Offizielle URL: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info Version: 1.4.0
Active Stand: 2026-09-23 Maschinenlesbarer Name: HttpResponseInfo

Copyright/Rechtliches: gematik GmbH / Dieses Artefakt ist lizenziert unter Apache License, Version 2.0.

Definiert Informationen zu HTTP-Antworten für FHIR-Interaktionen, inklusive Statuscode, Beschreibung, Beispiel und Response-Schema.

Context of Use

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formale Ansichten des Extension-Inhalts

Beschreibung von Profilen, Differentials, Snapshots und deren Repräsentationen.

Diese Struktur ist abgeleitet von Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension HTTP-Antwortinformationen
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:statusCode 1..1 Extension Der HTTP-Statuscode (z.B. 200, 201, 404, 500)
..... extension 0..0 Extension
..... url 1..1 uri "statusCode"
..... value[x] 0..1 string Value of extension
.... extension:description 1..1 Extension Kurze Beschreibung des Antwortfalls
..... extension 0..0 Extension
..... url 1..1 uri "description"
..... value[x] 0..1 string Value of extension
.... extension:example 0..1 Extension Optionales Beispiel für eine Antwortmeldung
..... extension 0..0 Extension
..... url 1..1 uri "example"
..... value[x] 0..1 string Value of extension
.... extension:format 0..1 Extension Format oder Struktur der Antwort, z.B. RFC7807
..... extension 0..0 Extension
..... url 1..1 uri "format"
..... value[x] 0..1 string Value of extension
.... extension:retryable 0..1 Extension Gibt an, ob die Antwort auf einen temporären Fehler hinweist und ein erneuter Versuch möglich ist
..... extension 0..0 Extension
..... url 1..1 uri "retryable"
..... value[x] 0..1 boolean Value of extension
.... extension:responseType 0..1 Extension Der erwartete Response-Typ oder Medientyp, z.B. OperationOutcome, application/json
..... extension 0..0 Extension
..... url 1..1 uri "responseType"
..... value[x] 0..1 string Value of extension
.... extension:errorCode 0..1 Extension Ein technischer oder semantischer Fehlercode, z.B. internalError
..... extension 0..0 Extension
..... url 1..1 uri "errorCode"
..... value[x] 0..1 string Value of extension
.... extension:interaction 0..1 Extension REST-Interaktion, für die diese Angabe gilt
..... extension 0..0 Extension
..... url 1..1 uri "interaction"
..... value[x] 0..1 code Value of extension
Binding: TI Restful Interaction ValueSet (required)
... url 1..1 uri "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.extension:interaction.​value[x] Base required TI Restful Interaction ValueSet 📦1.4.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension HTTP-Antwortinformationen
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusCode 1..1 Extension Der HTTP-Statuscode (z.B. 200, 201, 404, 500)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "statusCode"
..... value[x] 0..1 string Value of extension
.... extension:description 1..1 Extension Kurze Beschreibung des Antwortfalls
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "description"
..... value[x] 0..1 string Value of extension
.... extension:example 0..1 Extension Optionales Beispiel für eine Antwortmeldung
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "example"
..... value[x] 0..1 string Value of extension
.... extension:format 0..1 Extension Format oder Struktur der Antwort, z.B. RFC7807
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "format"
..... value[x] 0..1 string Value of extension
.... extension:retryable 0..1 Extension Gibt an, ob die Antwort auf einen temporären Fehler hinweist und ein erneuter Versuch möglich ist
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "retryable"
..... value[x] 0..1 boolean Value of extension
.... extension:responseType 0..1 Extension Der erwartete Response-Typ oder Medientyp, z.B. OperationOutcome, application/json
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "responseType"
..... value[x] 0..1 string Value of extension
.... extension:errorCode 0..1 Extension Ein technischer oder semantischer Fehlercode, z.B. internalError
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "errorCode"
..... value[x] 0..1 string Value of extension
.... extension:interaction 0..1 Extension REST-Interaktion, für die diese Angabe gilt
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "interaction"
..... value[x] 0..1 code Value of extension
Binding: TI Restful Interaction ValueSet (required)
... url 1..1 uri "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:interaction.​value[x] Base required TI Restful Interaction ValueSet 📦1.4.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Diese Struktur ist abgeleitet von Extension

Summary

Complex Extension: Definiert Informationen zu HTTP-Antworten für FHIR-Interaktionen, inklusive Statuscode, Beschreibung, Beispiel und Response-Schema.

  • statusCode: string: An Extension
  • description: string: An Extension
  • example: string: An Extension
  • format: string: An Extension
  • retryable: boolean: An Extension
  • responseType: string: An Extension
  • errorCode: string: An Extension
  • interaction: code: An Extension

Differential-AnsichtDifferential View

Diese Struktur ist abgeleitet von Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension HTTP-Antwortinformationen
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:statusCode 1..1 Extension Der HTTP-Statuscode (z.B. 200, 201, 404, 500)
..... extension 0..0 Extension
..... url 1..1 uri "statusCode"
..... value[x] 0..1 string Value of extension
.... extension:description 1..1 Extension Kurze Beschreibung des Antwortfalls
..... extension 0..0 Extension
..... url 1..1 uri "description"
..... value[x] 0..1 string Value of extension
.... extension:example 0..1 Extension Optionales Beispiel für eine Antwortmeldung
..... extension 0..0 Extension
..... url 1..1 uri "example"
..... value[x] 0..1 string Value of extension
.... extension:format 0..1 Extension Format oder Struktur der Antwort, z.B. RFC7807
..... extension 0..0 Extension
..... url 1..1 uri "format"
..... value[x] 0..1 string Value of extension
.... extension:retryable 0..1 Extension Gibt an, ob die Antwort auf einen temporären Fehler hinweist und ein erneuter Versuch möglich ist
..... extension 0..0 Extension
..... url 1..1 uri "retryable"
..... value[x] 0..1 boolean Value of extension
.... extension:responseType 0..1 Extension Der erwartete Response-Typ oder Medientyp, z.B. OperationOutcome, application/json
..... extension 0..0 Extension
..... url 1..1 uri "responseType"
..... value[x] 0..1 string Value of extension
.... extension:errorCode 0..1 Extension Ein technischer oder semantischer Fehlercode, z.B. internalError
..... extension 0..0 Extension
..... url 1..1 uri "errorCode"
..... value[x] 0..1 string Value of extension
.... extension:interaction 0..1 Extension REST-Interaktion, für die diese Angabe gilt
..... extension 0..0 Extension
..... url 1..1 uri "interaction"
..... value[x] 0..1 code Value of extension
Binding: TI Restful Interaction ValueSet (required)
... url 1..1 uri "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.extension:interaction.​value[x] Base required TI Restful Interaction ValueSet 📦1.4.0 This IG

Snapshot-Ansicht

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension HTTP-Antwortinformationen
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:statusCode 1..1 Extension Der HTTP-Statuscode (z.B. 200, 201, 404, 500)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "statusCode"
..... value[x] 0..1 string Value of extension
.... extension:description 1..1 Extension Kurze Beschreibung des Antwortfalls
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "description"
..... value[x] 0..1 string Value of extension
.... extension:example 0..1 Extension Optionales Beispiel für eine Antwortmeldung
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "example"
..... value[x] 0..1 string Value of extension
.... extension:format 0..1 Extension Format oder Struktur der Antwort, z.B. RFC7807
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "format"
..... value[x] 0..1 string Value of extension
.... extension:retryable 0..1 Extension Gibt an, ob die Antwort auf einen temporären Fehler hinweist und ein erneuter Versuch möglich ist
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "retryable"
..... value[x] 0..1 boolean Value of extension
.... extension:responseType 0..1 Extension Der erwartete Response-Typ oder Medientyp, z.B. OperationOutcome, application/json
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "responseType"
..... value[x] 0..1 string Value of extension
.... extension:errorCode 0..1 Extension Ein technischer oder semantischer Fehlercode, z.B. internalError
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "errorCode"
..... value[x] 0..1 string Value of extension
.... extension:interaction 0..1 Extension REST-Interaktion, für die diese Angabe gilt
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "interaction"
..... value[x] 0..1 code Value of extension
Binding: TI Restful Interaction ValueSet (required)
... url 1..1 uri "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:interaction.​value[x] Base required TI Restful Interaction ValueSet 📦1.4.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Diese Struktur ist abgeleitet von Extension

Summary

Complex Extension: Definiert Informationen zu HTTP-Antworten für FHIR-Interaktionen, inklusive Statuscode, Beschreibung, Beispiel und Response-Schema.

  • statusCode: string: An Extension
  • description: string: An Extension
  • example: string: An Extension
  • format: string: An Extension
  • retryable: boolean: An Extension
  • responseType: string: An Extension
  • errorCode: string: An Extension
  • interaction: code: An Extension

 

Weitere Repräsentationen des Profils: CSV, Excel, Schematron