DSTU2 STU 3 Candidate
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 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 . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

6.13 6.14 Parameters Resource Parameters Resource

6.13.1 Scope and Usage 6.14.1 Scope and Usage This special resource type is used to represent the

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

6.13.2 Boundaries and Relationships 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

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. page.

6.13.3 Resource Content 6.14.3 Resource Content

Structure

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

Documentation for this format doco Documentation for this format

XML Template 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]>
  <</resource>

  <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..* Content as for Parameters.parameter Named part of a parameter (e.g. Tuple) --></part>
 </parameter>
</Parameters>

JSON Template 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" : [{ Content as for Parameters.parameter }] // Named part of a parameter (e.g. Tuple)
  }]
}

Structure

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

Documentation for this format doco Documentation for this format

XML Template 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]>
  <</resource>

  <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..* Content as for Parameters.parameter Named part of a parameter (e.g. Tuple) --></part>
 </parameter>
</Parameters>

JSON Template 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" : [{ Content as for Parameters.parameter }] // Named part of a parameter (e.g. Tuple)
  }]
}

6.13.3.1 Constraints 6.14.3.1 Constraints

  • inv-1 : On Parameters.parameter: A parameter must have a value or a resource, but not both (xpath on f:Parameters/f:parameter: exists(f:value) or exists(f:resource) and not(exists(f:value) and exists(f:resource)) ) inv-2 : On Parameters.parameter.part: A part must have a value or a resource, but not both (xpath on f:Parameters/f:parameter/f:part: exists(f:value) or exists(f:resource) and not(exists(f:value) and exists(f:resource)) : On Parameters.parameter: A parameter must have only one of (value, resource, part) ( expression on Parameters.parameter: value xor resource )
    • Note: for technical compatibility reasons, the

Note: for technical compatibility reasons, the Parameters resource 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 inherits from Resource (tags, profiles, security labels, language etc.) may have use when operations are executed. © HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search , 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.