FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions . Page versions: R4B R4 R3 R2

Content Detailed Descriptions Mappings XML JSON

Example OperationDefinition/Subscription-status (XML)

Extension: http-response-header   Maturity Level : 1 URL for this extension: http://hl7.org/fhir/StructureDefinition/http-response-header
Responsible Owner: FHIR Infrastructure Work Group Standards Status : Informative Use Context : Any
    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 Narrative
    • Full Structure
  • XML
  • JSON
  • All TTL

Summary Name Flags Card. Type Description & Constraints extension Raw XML 0..* string ( canonical form 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 + also see XML Format Specification Full Structure )

Name Flags 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 Operation Definition

<!-- http-response-header --> 
<?xml version="1.0" encoding="UTF-8"?>


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

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Subscription-status"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p class="res-header-id">
        <b> Generated Narrative: OperationDefinition Subscription-status</b> 
      </p> 
      <a name="Subscription-status"> </a> 
      <a name="hcSubscription-status"> </a> 
      <p> URL: [base]/Subscription/$status</p> 
      <p> URL: [base]/Subscription/[id]/$status</p> 
      <h3> Parameters</h3> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Use</b> 
          </td> 
          <td> 
            <b> Name</b> 
          </td> 
          <td> 
            <b> Scope</b> 
          </td> 
          <td> 
            <b> Cardinality</b> 
          </td> 
          <td> 
            <b> Type</b> 
          </td> 
          <td> 
            <b> Binding</b> 
          </td> 
          <td> 
            <b> Documentation</b> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> id</td> 
          <td> type</td> 
          <td> 0..*</td> 
          <td> 
            <a href="datatypes.html#id">id</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> At the Instance level, this parameter is ignored. At the Resource level, one or
                 more FHIR ids to Subscription resources to get status information for. In the absence
                 of any specified ids, the server returns the status for all Subscriptions available
                 to the caller. Multiple values are joined via OR (e.g., &quot;id1&quot; OR &quot;id2&quot;).</p> 

JSON
Template

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> IN</td> 
          <td> status</td> 
          <td> type</td> 
          <td> 0..*</td> 
          <td> 
            <a href="datatypes.html#code">code</a> 
          </td> 
          <td> 
            <a href="valueset-subscription-status.html">Subscription Status</a>  (Required)
          </td> 
          <td> 
            <div> 
              <p> At the Instance level, this parameter is ignored. At the Resource level, a Subscription
                 status code to filter by (e.g., &quot;active&quot;). In the absence of any specified
                 status values, the server does not filter contents based on the status. Multiple
                 values are joined via OR (e.g., &quot;error&quot; OR &quot;off&quot;).</p> 

  
{ // 
  // from Element: 
    "
    ],
    " 
    "
  }

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> return</td> 
          <td/>  
          <td> 1..1</td> 
          <td> 
            <a href="bundle.html">Bundle</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The operation returns a bundle containing zero or more SubscriptionStatus resources,
                 one per Subscription in the request that was found. The Bundle type is &quot;searchset&quot;.</p> 

Summary

            </div> 
          </td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="2"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <url value="http://hl7.org/fhir/OperationDefinition/Subscription-status"/> 
  <version value="6.0.0-ballot3"/> 
  <name value="Status"/> 
  <title value="Get Current Subscription Status for One or More Subscriptions"/> 
  <status value="active"/> 
  <kind value="operation"/> 
  <experimental value="false"/> 
  <date value="2025-12-17T09:50:17+00:00"/> 
  <publisher value="HL7 International / FHIR Infrastructure"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://www.hl7.org/Special/committees/fiwg"/> 
    </telecom> 
  </contact> 
  <description value="This operation is used to get current status information about one or more topic-based
   Subscriptions, each described by a SubscriptionStatus resource."/> 
  <jurisdiction>     <coding>       <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>       <code value="001"/>       <display value="World"/>     </coding>   </jurisdiction>   <affectsState value="false"/>   <code value="status"/>   <resource value="Subscription"/>   <system value="false"/>   <type value="true"/>   <instance value="true"/>   <parameter>     <name value="id"/>     <use value="in"/>     <scope value="type"/>     <min value="0"/>     <max value="*"/>     <documentation value="At the Instance level, this parameter is ignored. At the Resource level, one or

     more FHIR ids to Subscription resources to get status information for. In the absence
     of any specified ids, the server returns the status for all Subscriptions available
     to the caller. Multiple values are joined via OR (e.g., &quot;id1&quot; OR &quot;id2&quot;)."/> 
    <type value="id"/>   </parameter>   <parameter>     <name value="status"/>     <use value="in"/>     <scope value="type"/>     <min value="0"/>     <max value="*"/>     <documentation value="At the Instance level, this parameter is ignored. At the Resource level, a Subscription

     status code to filter by (e.g., &quot;active&quot;). In the absence of any specified
     status values, the server does not filter contents based on the status. Multiple
     values are joined via OR (e.g., &quot;error&quot; OR &quot;off&quot;)."/> 
    <type value="code"/>     <binding>       <strength value="required"/>       <valueSet value="http://hl7.org/fhir/ValueSet/subscription-status|6.0.0-ballot3"/>     </binding>   </parameter>   <parameter>     <name value="return"/>     <use value="out"/>     <min value="1"/>     <max value="1"/>     <documentation value="The operation returns a bundle containing zero or more SubscriptionStatus resources,

     one per Subscription in the request that was found. The Bundle type is &quot;searchset&quot;."/> 
    <type value="Bundle"/>   </parameter> 

Name
Flags
Card.
Type
Description
&
Constraints


</

OperationDefinition


>


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 Flags Card. Type Description & Constraints extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/http-response-header http-response-header: In a transaction, Usage note: every single interaction can have multiple HTTP response headers returned as effort has been made to ensure that the examples are correct and useful, but they are not a result normative part 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 --> < xmlns="http://hl7.org/fhir" url="" > <!-- from Element: < </extension> JSON Template { // // from Element: " ], " " }   Constraints specification.

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')]) )