STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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

2.41 Parameters Resource

2.41.1 Scope and Usage

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

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

Structure

Name	Flags	Card.	Type	Description & Constraints
Parameters			Resource	Operation Request or Response
parameter	I	0..*	BackboneElement	Operation Parameter A parameter must have only one of (value, resource, part)
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		0..*	see parameter	Named part of a multi-part parameter
Documentation for this format

UML Diagram (Legend)

XML Template

<Parameters xmlns="http://hl7.org/fhir"> 
 <!-- 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..* Content as for Parameters.parameter Named part of a multi-part parameter --></part>
 </parameter>
</Parameters>

JSON Template

{
  "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 multi-part parameter
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Parameters.parameter [ # 0..* Operation Parameter
    fhir:Parameters.parameter.name [ string ]; # 1..1 Name from the definition
    # Parameters.parameter.value[x] : 0..1 If parameter is a data type. One of these 38
      fhir:Parameters.parameter.valueBase64Binary [ base64Binary ]
      fhir:Parameters.parameter.valueBoolean [ boolean ]
      fhir:Parameters.parameter.valueCode [ code ]
      fhir:Parameters.parameter.valueDate [ date ]
      fhir:Parameters.parameter.valueDateTime [ dateTime ]
      fhir:Parameters.parameter.valueDecimal [ decimal ]
      fhir:Parameters.parameter.valueId [ id ]
      fhir:Parameters.parameter.valueInstant [ instant ]
      fhir:Parameters.parameter.valueInteger [ integer ]
      fhir:Parameters.parameter.valueMarkdown [ markdown ]
      fhir:Parameters.parameter.valueOid [ oid ]
      fhir:Parameters.parameter.valuePositiveInt [ positiveInt ]
      fhir:Parameters.parameter.valueString [ string ]
      fhir:Parameters.parameter.valueTime [ time ]
      fhir:Parameters.parameter.valueUnsignedInt [ unsignedInt ]
      fhir:Parameters.parameter.valueUri [ uri ]
      fhir:Parameters.parameter.valueAddress [ Address ]
      fhir:Parameters.parameter.valueAge [ Age ]
      fhir:Parameters.parameter.valueAnnotation [ Annotation ]
      fhir:Parameters.parameter.valueAttachment [ Attachment ]
      fhir:Parameters.parameter.valueCodeableConcept [ CodeableConcept ]
      fhir:Parameters.parameter.valueCoding [ Coding ]
      fhir:Parameters.parameter.valueContactPoint [ ContactPoint ]
      fhir:Parameters.parameter.valueCount [ Count ]
      fhir:Parameters.parameter.valueDistance [ Distance ]
      fhir:Parameters.parameter.valueDuration [ Duration ]
      fhir:Parameters.parameter.valueHumanName [ HumanName ]
      fhir:Parameters.parameter.valueIdentifier [ Identifier ]
      fhir:Parameters.parameter.valueMoney [ Money ]
      fhir:Parameters.parameter.valuePeriod [ Period ]
      fhir:Parameters.parameter.valueQuantity [ Quantity ]
      fhir:Parameters.parameter.valueRange [ Range ]
      fhir:Parameters.parameter.valueRatio [ Ratio ]
      fhir:Parameters.parameter.valueReference [ Reference ]
      fhir:Parameters.parameter.valueSampledData [ SampledData ]
      fhir:Parameters.parameter.valueSignature [ Signature ]
      fhir:Parameters.parameter.valueTiming [ Timing ]
      fhir:Parameters.parameter.valueMeta [ Meta ]
    fhir:Parameters.parameter.resource [ Resource ]; # 0..1 If parameter is a whole resource
    fhir:Parameters.parameter.part [ See Parameters.parameter ], ... ; # 0..* Named part of a multi-part parameter
  ], ...;
]

Structure

Name	Flags	Card.	Type	Description & Constraints
Parameters			Resource	Operation Request or Response
parameter	I	0..*	BackboneElement	Operation Parameter A parameter must have only one of (value, resource, part)
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		0..*	see parameter	Named part of a multi-part parameter
Documentation for this format

UML Diagram (Legend)

XML Template

<Parameters xmlns="http://hl7.org/fhir"> 
 <!-- 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..* Content as for Parameters.parameter Named part of a multi-part parameter --></part>
 </parameter>
</Parameters>

JSON Template

{
  "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 multi-part parameter
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Parameters.parameter [ # 0..* Operation Parameter
    fhir:Parameters.parameter.name [ string ]; # 1..1 Name from the definition
    # Parameters.parameter.value[x] : 0..1 If parameter is a data type. One of these 38
      fhir:Parameters.parameter.valueBase64Binary [ base64Binary ]
      fhir:Parameters.parameter.valueBoolean [ boolean ]
      fhir:Parameters.parameter.valueCode [ code ]
      fhir:Parameters.parameter.valueDate [ date ]
      fhir:Parameters.parameter.valueDateTime [ dateTime ]
      fhir:Parameters.parameter.valueDecimal [ decimal ]
      fhir:Parameters.parameter.valueId [ id ]
      fhir:Parameters.parameter.valueInstant [ instant ]
      fhir:Parameters.parameter.valueInteger [ integer ]
      fhir:Parameters.parameter.valueMarkdown [ markdown ]
      fhir:Parameters.parameter.valueOid [ oid ]
      fhir:Parameters.parameter.valuePositiveInt [ positiveInt ]
      fhir:Parameters.parameter.valueString [ string ]
      fhir:Parameters.parameter.valueTime [ time ]
      fhir:Parameters.parameter.valueUnsignedInt [ unsignedInt ]
      fhir:Parameters.parameter.valueUri [ uri ]
      fhir:Parameters.parameter.valueAddress [ Address ]
      fhir:Parameters.parameter.valueAge [ Age ]
      fhir:Parameters.parameter.valueAnnotation [ Annotation ]
      fhir:Parameters.parameter.valueAttachment [ Attachment ]
      fhir:Parameters.parameter.valueCodeableConcept [ CodeableConcept ]
      fhir:Parameters.parameter.valueCoding [ Coding ]
      fhir:Parameters.parameter.valueContactPoint [ ContactPoint ]
      fhir:Parameters.parameter.valueCount [ Count ]
      fhir:Parameters.parameter.valueDistance [ Distance ]
      fhir:Parameters.parameter.valueDuration [ Duration ]
      fhir:Parameters.parameter.valueHumanName [ HumanName ]
      fhir:Parameters.parameter.valueIdentifier [ Identifier ]
      fhir:Parameters.parameter.valueMoney [ Money ]
      fhir:Parameters.parameter.valuePeriod [ Period ]
      fhir:Parameters.parameter.valueQuantity [ Quantity ]
      fhir:Parameters.parameter.valueRange [ Range ]
      fhir:Parameters.parameter.valueRatio [ Ratio ]
      fhir:Parameters.parameter.valueReference [ Reference ]
      fhir:Parameters.parameter.valueSampledData [ SampledData ]
      fhir:Parameters.parameter.valueSignature [ Signature ]
      fhir:Parameters.parameter.valueTiming [ Timing ]
      fhir:Parameters.parameter.valueMeta [ Meta ]
    fhir:Parameters.parameter.resource [ Resource ]; # 0..1 If parameter is a whole resource
    fhir:Parameters.parameter.part [ See Parameters.parameter ], ... ; # 0..* Named part of a multi-part parameter
  ], ...;
]

2.41.3.1 Constraints

inv-1: On Parameters.parameter: A parameter must have only one of (value, resource, part) (expression on Parameters.parameter: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))

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 (tags, profiles, security labels, language etc.) may have use when operations are executed.