description: Definiert Informationen zu HTTP-Antworten für FHIR-Interaktionen, inklusive Statuscode, Beschreibung, Beispiel und Response-Schema.
package_name: de.gematik.epa
derivation: constraint
name: HttpResponseInfo
type: Extension
elements:
  extension:
    array: true
    min: 2
    index: 0
    slicing:
      slices:
        statusCode:
          match: {}
          schema:
            short: Der HTTP-Statuscode (z.B. 200, 201, 404, 500)
            _required: true
            index: 1
            extensions: {}
            elements:
              extension: {index: 2}
              url:
                pattern: {type: uri, value: statusCode}
                type: uri
                index: 3
              value:
                choices: [valueString]
                index: 5
              valueString: {type: string, choiceOf: value, index: 6}
        description:
          match: {}
          schema:
            short: Kurze Beschreibung des Antwortfalls
            _required: true
            index: 7
            extensions: {}
            elements:
              extension: {index: 8}
              url:
                pattern: {type: uri, value: description}
                type: uri
                index: 9
              value:
                choices: [valueString]
                index: 11
              valueString: {type: string, choiceOf: value, index: 12}
        example:
          match: {}
          schema:
            short: Optionales Beispiel für eine Antwortmeldung
            index: 13
            extensions: {}
            elements:
              extension: {index: 14}
              url:
                pattern: {type: uri, value: example}
                type: uri
                index: 15
              value:
                choices: [valueString]
                index: 17
              valueString: {type: string, choiceOf: value, index: 18}
        format:
          match: {}
          schema:
            short: Format oder Struktur der Antwort, z.B. RFC7807
            index: 19
            extensions: {}
            elements:
              extension: {index: 20}
              url:
                pattern: {type: uri, value: format}
                type: uri
                index: 21
              value:
                choices: [valueString]
                index: 23
              valueString: {type: string, choiceOf: value, index: 24}
        retryable:
          match: {}
          schema:
            short: Gibt an, ob die Antwort auf einen temporären Fehler hinweist und ein erneuter Versuch möglich ist
            index: 25
            extensions: {}
            elements:
              extension: {index: 26}
              url:
                pattern: {type: uri, value: retryable}
                type: uri
                index: 27
              value:
                choices: [valueBoolean]
                index: 29
              valueBoolean: {type: boolean, choiceOf: value, index: 30}
        responseType:
          match: {}
          schema:
            short: Der erwartete Response-Typ oder Medientyp, z.B. OperationOutcome, application/json
            index: 31
            extensions: {}
            elements:
              extension: {index: 32}
              url:
                pattern: {type: uri, value: responseType}
                type: uri
                index: 33
              value:
                choices: [valueString]
                index: 35
              valueString: {type: string, choiceOf: value, index: 36}
        errorCode:
          match: {}
          schema:
            short: Ein technischer oder semantischer Fehlercode, z.B. internalError
            index: 37
            extensions: {}
            elements:
              extension: {index: 38}
              url:
                pattern: {type: uri, value: errorCode}
                type: uri
                index: 39
              value:
                choices: [valueString]
                index: 41
              valueString: {type: string, choiceOf: value, index: 42}
  url:
    pattern: {type: uri, value: 'https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion'}
    type: uri
    index: 43
  value:
    choices: []
    index: 45
package_version: 1.0.6-1
extensions:
  statusCode:
    url: null
    short: Der HTTP-Statuscode (z.B. 200, 201, 404, 500)
    _required: true
    index: 1
    extensions: {}
    elements:
      extension: {index: 2}
      url:
        pattern: {type: uri, value: statusCode}
        type: uri
        index: 3
      value:
        choices: [valueString]
        index: 5
      valueString: {type: string, choiceOf: value, index: 6}
  description:
    url: null
    short: Kurze Beschreibung des Antwortfalls
    _required: true
    index: 7
    extensions: {}
    elements:
      extension: {index: 8}
      url:
        pattern: {type: uri, value: description}
        type: uri
        index: 9
      value:
        choices: [valueString]
        index: 11
      valueString: {type: string, choiceOf: value, index: 12}
  example:
    url: null
    short: Optionales Beispiel für eine Antwortmeldung
    index: 13
    extensions: {}
    elements:
      extension: {index: 14}
      url:
        pattern: {type: uri, value: example}
        type: uri
        index: 15
      value:
        choices: [valueString]
        index: 17
      valueString: {type: string, choiceOf: value, index: 18}
  format:
    url: null
    short: Format oder Struktur der Antwort, z.B. RFC7807
    index: 19
    extensions: {}
    elements:
      extension: {index: 20}
      url:
        pattern: {type: uri, value: format}
        type: uri
        index: 21
      value:
        choices: [valueString]
        index: 23
      valueString: {type: string, choiceOf: value, index: 24}
  retryable:
    url: null
    short: Gibt an, ob die Antwort auf einen temporären Fehler hinweist und ein erneuter Versuch möglich ist
    index: 25
    extensions: {}
    elements:
      extension: {index: 26}
      url:
        pattern: {type: uri, value: retryable}
        type: uri
        index: 27
      value:
        choices: [valueBoolean]
        index: 29
      valueBoolean: {type: boolean, choiceOf: value, index: 30}
  responseType:
    url: null
    short: Der erwartete Response-Typ oder Medientyp, z.B. OperationOutcome, application/json
    index: 31
    extensions: {}
    elements:
      extension: {index: 32}
      url:
        pattern: {type: uri, value: responseType}
        type: uri
        index: 33
      value:
        choices: [valueString]
        index: 35
      valueString: {type: string, choiceOf: value, index: 36}
  errorCode:
    url: null
    short: Ein technischer oder semantischer Fehlercode, z.B. internalError
    index: 37
    extensions: {}
    elements:
      extension: {index: 38}
      url:
        pattern: {type: uri, value: errorCode}
        type: uri
        index: 39
      value:
        choices: [valueString]
        index: 41
      valueString: {type: string, choiceOf: value, index: 42}
class: extension
kind: complex-type
url: https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion
base: http://hl7.org/fhir/StructureDefinition/Extension
version: 1.0.6-1