This page is part of the FHIR Specification (v0.0.82: DSTU 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: R5 R4B R4 R3 R2

6.14 Parameters Resource

6.14.1 Scope and Usage

This special resource type is used to represent the operation request and response.

6.14.2 Boundaries and Relationships

This special resource has no other use than for operation parameters, and there is no RESTful end=point associated with it. For further information, see the operations page.

6.14.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . Parameters Resource Operation Request or Response
. . . parameter I 0..* Element Operation Parameter
A parameter must have a value or a resource, but not both
. . . . name 1..1 string Name from the definition
. . . . value[x] I 0..1 * If parameter is a data type
. . . . resource I 0..1 Resource If parameter is a whole resource
. . . . part I 0..* Element Named part of a parameter (e.g. Tuple)
A part must have a value or a resource, but not both
. . . . . name 1..1 string Name from the definition
. . . . . value[x] I 0..1 * Value of the part
. . . . . resource I 0..1 Resource If part is a whole resource

XML Template 

<Parameters xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <parameter>  <!-- 0..* Operation Parameter -->
  <name value="[string]"/><!-- 1..1 Name from the definition -->
  <value[x]><!-- ?? 0..1 * If parameter is a data type --></value[x]>
  <resource><!-- ?? 0..1 Resource If parameter is a whole resource --></resource>
  <part>  <!-- 0..* Named part of a parameter (e.g. Tuple) -->
   <name value="[string]"/><!-- 1..1 Name from the definition -->
   <value[x]><!-- ?? 0..1 * Value of the part --></value[x]>
   <resource><!-- ?? 0..1 Resource If part is a whole resource --></resource>
  </part>
 </parameter>
</Parameters>

JSON Template 

{doco
  "resourceType" : "Parameters",
  // from Resource: id, meta, implicitRules, and language
  "parameter" : [{ // Operation Parameter
    "name" : "<string>", // R!  Name from the definition
    // value[x]: If parameter is a data type. One of these 23:
    "valueInteger" : <integer>,
    "valueDecimal" : <decimal>,
    "valueDateTime" : "<dateTime>",
    "valueDate" : "<date>",
    "valueInstant" : "<instant>",
    "valueString" : "<string>",
    "valueUri" : "<uri>",
    "valueBoolean" : <boolean>,
    "valueCode" : "<code>",
    "valueBase64Binary" : "<base64Binary>",
    "valueCoding" : { Coding },
    "valueCodeableConcept" : { CodeableConcept },
    "valueAttachment" : { Attachment },
    "valueIdentifier" : { Identifier },
    "valueQuantity" : { Quantity },
    "valueRange" : { Range },
    "valuePeriod" : { Period },
    "valueRatio" : { Ratio },
    "valueHumanName" : { HumanName },
    "valueAddress" : { Address },
    "valueContactPoint" : { ContactPoint },
    "valueSchedule" : { Schedule },
    "valueReference" : { Reference },
    "resource" : { Resource }, // C? If parameter is a whole resource
    "part" : [{ // Named part of a parameter (e.g. Tuple)
      "name" : "<string>", // R!  Name from the definition
      // value[x]: Value of the part. One of these 23:
      "valueInteger" : <integer>,
      "valueDecimal" : <decimal>,
      "valueDateTime" : "<dateTime>",
      "valueDate" : "<date>",
      "valueInstant" : "<instant>",
      "valueString" : "<string>",
      "valueUri" : "<uri>",
      "valueBoolean" : <boolean>,
      "valueCode" : "<code>",
      "valueBase64Binary" : "<base64Binary>",
      "valueCoding" : { Coding },
      "valueCodeableConcept" : { CodeableConcept },
      "valueAttachment" : { Attachment },
      "valueIdentifier" : { Identifier },
      "valueQuantity" : { Quantity },
      "valueRange" : { Range },
      "valuePeriod" : { Period },
      "valueRatio" : { Ratio },
      "valueHumanName" : { HumanName },
      "valueAddress" : { Address },
      "valueContactPoint" : { ContactPoint },
      "valueSchedule" : { Schedule },
      "valueReference" : { Reference },
      "resource" : { Resource } // C? If part is a whole resource
    }]
  }]
}

Structure

Name Flags Card. Type Description & Constraints doco
. . Parameters Resource Operation Request or Response
. . . parameter I 0..* Element Operation Parameter
A parameter must have a value or a resource, but not both
. . . . name 1..1 string Name from the definition
. . . . value[x] I 0..1 * If parameter is a data type
. . . . resource I 0..1 Resource If parameter is a whole resource
. . . . part I 0..* Element Named part of a parameter (e.g. Tuple)
A part must have a value or a resource, but not both
. . . . . name 1..1 string Name from the definition
. . . . . value[x] I 0..1 * Value of the part
. . . . . resource I 0..1 Resource If part is a whole resource

XML Template 

<Parameters xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <parameter>  <!-- 0..* Operation Parameter -->
  <name value="[string]"/><!-- 1..1 Name from the definition -->
  <value[x]><!-- ?? 0..1 * If parameter is a data type --></value[x]>
  <resource><!-- ?? 0..1 Resource If parameter is a whole resource --></resource>
  <part>  <!-- 0..* Named part of a parameter (e.g. Tuple) -->
   <name value="[string]"/><!-- 1..1 Name from the definition -->
   <value[x]><!-- ?? 0..1 * Value of the part --></value[x]>
   <resource><!-- ?? 0..1 Resource If part is a whole resource --></resource>
  </part>
 </parameter>
</Parameters>

JSON Template 

{doco
  "resourceType" : "Parameters",
  // from Resource: id, meta, implicitRules, and language
  "parameter" : [{ // Operation Parameter
    "name" : "<string>", // R!  Name from the definition
    // value[x]: If parameter is a data type. One of these 23:
    "valueInteger" : <integer>,
    "valueDecimal" : <decimal>,
    "valueDateTime" : "<dateTime>",
    "valueDate" : "<date>",
    "valueInstant" : "<instant>",
    "valueString" : "<string>",
    "valueUri" : "<uri>",
    "valueBoolean" : <boolean>,
    "valueCode" : "<code>",
    "valueBase64Binary" : "<base64Binary>",
    "valueCoding" : { Coding },
    "valueCodeableConcept" : { CodeableConcept },
    "valueAttachment" : { Attachment },
    "valueIdentifier" : { Identifier },
    "valueQuantity" : { Quantity },
    "valueRange" : { Range },
    "valuePeriod" : { Period },
    "valueRatio" : { Ratio },
    "valueHumanName" : { HumanName },
    "valueAddress" : { Address },
    "valueContactPoint" : { ContactPoint },
    "valueSchedule" : { Schedule },
    "valueReference" : { Reference },
    "resource" : { Resource }, // C? If parameter is a whole resource
    "part" : [{ // Named part of a parameter (e.g. Tuple)
      "name" : "<string>", // R!  Name from the definition
      // value[x]: Value of the part. One of these 23:
      "valueInteger" : <integer>,
      "valueDecimal" : <decimal>,
      "valueDateTime" : "<dateTime>",
      "valueDate" : "<date>",
      "valueInstant" : "<instant>",
      "valueString" : "<string>",
      "valueUri" : "<uri>",
      "valueBoolean" : <boolean>,
      "valueCode" : "<code>",
      "valueBase64Binary" : "<base64Binary>",
      "valueCoding" : { Coding },
      "valueCodeableConcept" : { CodeableConcept },
      "valueAttachment" : { Attachment },
      "valueIdentifier" : { Identifier },
      "valueQuantity" : { Quantity },
      "valueRange" : { Range },
      "valuePeriod" : { Period },
      "valueRatio" : { Ratio },
      "valueHumanName" : { HumanName },
      "valueAddress" : { Address },
      "valueContactPoint" : { ContactPoint },
      "valueSchedule" : { Schedule },
      "valueReference" : { Reference },
      "resource" : { Resource } // C? If part is a whole resource
    }]
  }]
}

6.14.3.1 Constraints

Note: for technical compatibility reasons, the Parameters resouce inherits from Resource , but since the parameter exchange format has no end point and/or persistence, it never has an id, a versionId, or a lastUpdated. The other features of Resource (tags, profiles, security labels, language etc) may have use when operations are executed.