Implementation Guide
ePA Basisfunktionalitäten
Version 1.0.6 - release

Extension: HTTP-Antwortinformationen

Official URL: https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion Version: 1.0.6
Active as of 2025-05-09 Computable Name: HttpResponseInfo

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

Context of Use

This extension may be used on the following element(s):

  • Element ID CapabilityStatement
  • Element ID CapabilityStatement.rest.resource.interaction
  • Element ID CapabilityStatement.rest.operation
  • Element ID CapabilityStatement.rest.resource.operation

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from 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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
..... 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
..... 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
..... 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
..... 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
..... 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
..... 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
..... url 1..1 uri "errorCode"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
..... 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
..... 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
..... 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
..... 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
..... 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
..... 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
..... url 1..1 uri "errorCode"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"

doco Documentation for this format

This structure is derived from 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

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
..... 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
..... 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
..... 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
..... 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
..... 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
..... 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
..... url 1..1 uri "errorCode"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
..... 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
..... 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
..... 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
..... 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
..... 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
..... 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
..... url 1..1 uri "errorCode"
..... value[x] 0..1 string Value of extension
... url 1..1 uri "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()