R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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

Extension: 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

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	string	URL = http://hl7.org/fhir/StructureDefinition/http-response-header 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
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/http-response-header 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	0..1	string	Value of extension
Documentation for this format

XML Template

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

<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 order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/http-response-header", // R! 
    "valueString" : "<string>" //Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	string	URL = http://hl7.org/fhir/StructureDefinition/http-response-header 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
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/http-response-header 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	0..1	string	Value of extension
Documentation for this format

XML Template

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

<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 order, Open ]
    "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')]))