DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 3). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2 R3 R2

Extension: HTTP header returned by the interaction http-response-header

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/http-response-header

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR Core WG

In a transaction, every single interaction can have multiple HTTP response headers returned as a result of the interaction.

Context of Use: Use on element: Bundle.entry.response

usage info: insert a list of places where this extension is used

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* string URL = http://hl7.org/fhir/StructureDefinition/http-response-header
HTTP header returned by the interaction: http-response-header: In a transaction, every single interaction can have multiple HTTP response headers returned as a result of the interaction.
Use on element: Bundle.entry.response

doco Documentation for this format

Fulle Full Structure

extension 0 .. 0
Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/http-response-header
HTTP header returned by the interaction: http-response-header: In a transaction, every single interaction can have multiple HTTP response headers returned as a result of the interaction.
Use on element: Bundle.entry.response
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/http-response-header"
. . . valueString 1..1 0..1 string Value of extension

doco Documentation for this format

XML Template 

<!-- HTTP header returned by the interaction -->

<!-- http-response-header -->doco


<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/http-response-header" >
  <!-- from Element: extension -->
 <

 <valueString value="[string]"/><!-- 0..1 Value of extension -->

</extension>

JSON Template 

{ // 

{ // http-response-header

  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified orderOpen
    ],

    "url" : "http://hl7.org/fhir/StructureDefinition/http-response-header", // R! 
    "

    "valueString" : "<string>" //Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* string URL = http://hl7.org/fhir/StructureDefinition/http-response-header
HTTP header returned by the interaction: http-response-header: In a transaction, every single interaction can have multiple HTTP response headers returned as a result of the interaction.
Use on element: Bundle.entry.response

doco Documentation for this format

Full Structure

extension 0 .. 0
Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/http-response-header
HTTP header returned by the interaction: http-response-header: In a transaction, every single interaction can have multiple HTTP response headers returned as a result of the interaction.
Use on element: Bundle.entry.response
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/http-response-header"
. . . valueString 1..1 0..1 string Value of extension

doco Documentation for this format

XML Template 

<!-- HTTP header returned by the interaction -->

<!-- http-response-header -->doco


<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/http-response-header" >
  <!-- from Element: extension -->
 <

 <valueString value="[string]"/><!-- 0..1 Value of extension -->

</extension>

JSON Template 

{ // 

{ // http-response-header

  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified orderOpen
    ],

    "url" : "http://hl7.org/fhir/StructureDefinition/http-response-header", // R! 
    "

    "valueString" : "<string>" //Value of extension

  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children (xpath: @value|f:*|h:div )
  • ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) )