OperationDefinition.parameter

FHIR attribute (r4)

In the OperationDefinition resource for FHIR r4 , the parameter attribute identifies the Parameters for the operation/query

parameter (OperationDefinition) description

Resource Type: OperationDefinition

Attribute Name: parameter

Description: Parameters for the operation/query

FHIR Version: r4

Attribute Type :

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

OperationDefinition.parameter Example

"parameter": [
  {
    "name": "subject",
    "use": "in",
    "min": 1,
    "max": "1",
    "documentation": "The resource that is to be the *QuestionnaireResponse.subject*. The [[[QuestionnaireResponse]]]      instance will reference the provided subject.  In addition, if the *local* parameter is      set to true, server information about the specified subject will be used to populate the      instance.",
    "type": "Reference"
  },
  {
    "name": "local",
    "use": "in",
    "min": 0,
    "max": "1",
    "documentation": "If the *local* parameter is set to true, server information about the specified subject will be used to populate the instance.",
    "type": "Reference"
  },
  {
    "name": "return",
    "use": "out",
    "min": 1,
    "max": "1",
    "documentation": "The partially (or fully)-populated set of answers for the specified Questionnaire",
    "type": "QuestionnaireResponse"
  }
]

OperationDefinition attributes

AttributeField is listTypeDescription

Description: Canonical identifier for this operation definition, represented as a URI (globally unique)

FHIR Version: r4

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"url": "http://h7.org/fhir/OperationDefinition/example"

Learn more about the (OperationDefinition) url FHIR attribute

Description: Business version of the operation definition

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"version": "B"

Learn more about the (OperationDefinition) version FHIR attribute

Description: C? Name for this operation definition (computer friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name": "Populate Questionnaire"

Learn more about the (OperationDefinition) name FHIR attribute

Description: Name for this operation definition (human friendly)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"title":

Learn more about the (OperationDefinition) title FHIR attribute

Description: draft | active | retired | unknown

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "draft"

Learn more about the (OperationDefinition) status FHIR attribute

Description: operation | query

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"kind": "operation"

Learn more about the (OperationDefinition) kind FHIR attribute

Description: For testing purposes, not real usage

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"experimental":

Learn more about the (OperationDefinition) experimental FHIR attribute

Description: Date last changed

FHIR Version: r4

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"date": "2015-08-04"

Learn more about the (OperationDefinition) date FHIR attribute

Description: Name of the publisher (organization or individual)

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"publisher": "Acme Healthcare Services"

Learn more about the (OperationDefinition) publisher FHIR attribute

Description: Contact details for the publisher

FHIR Version: r4

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact": [
  {
    "name": "System Administrator",
    "telecom": [
      {
        "system": "email",
        "value": "beep@coyote.acme.com"
      }
    ]
  }
]

Learn more about the (OperationDefinition) contact FHIR attribute

Description: Natural language description of the operation definition

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description": "Limited implementation of the Populate Questionnaire implementation"

Learn more about the (OperationDefinition) description FHIR attribute

Description: The context that the content is intended to support

FHIR Version: r4

Attribute Type : UsageContext

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"useContext": [
  {
    "code": {
      "system": "http://build.fhir.org/codesystem-usage-context-type",
      "code": "venue",
      "display": "Clinical Venue"
    },
    "valueCodeableConcept": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "code": "IMP",
          "display": "inpatient encounter"
        }
      ]
    }
  }
]

Learn more about the (OperationDefinition) useContext FHIR attribute

Description: Intended jurisdiction for operation definition (if applicable)

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"jurisdiction": [
  {
    "coding": [
      {
        "system": "urn:iso:std:iso:3166",
        "code": "GB",
        "display": "United Kingdom of Great Britain and Northern Ireland (the)"
      }
    ]
  }
]

Learn more about the (OperationDefinition) jurisdiction FHIR attribute

Description: Why this operation definition is defined

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"purpose":

Learn more about the (OperationDefinition) purpose FHIR attribute

Description: Whether content is changed by the operation

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"affectsState":

Learn more about the (OperationDefinition) affectsState FHIR attribute

Description: Name used to invoke the operation

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"code": "populate"

Learn more about the (OperationDefinition) code FHIR attribute

Description: Additional information about use

FHIR Version: r4

Attribute Type : markdown

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"comment": "Only implemented for Labs and Medications so far"

Learn more about the (OperationDefinition) comment FHIR attribute

Description: Marks this as a profile of the base

FHIR Version: r4

Attribute Type : canonical(OperationDefinition)

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"base": "OperationDefinition/Questionnaire-populate"

Learn more about the (OperationDefinition) base FHIR attribute

Description: Types this operation applies to

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"resource": [
  "Questionnaire"
]

Learn more about the (OperationDefinition) resource FHIR attribute

Description: Invoke at the system level?

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"system": false

Learn more about the (OperationDefinition) system FHIR attribute

Description: Invoke at the type level?

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"type": false

Learn more about the (OperationDefinition) type FHIR attribute

Description: Invoke on an instance?

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"instance": true

Learn more about the (OperationDefinition) instance FHIR attribute

Description: Validation information for in parameters

FHIR Version: r4

Attribute Type : canonical(StructureDefinition)

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"inputProfile":

Learn more about the (OperationDefinition) inputProfile FHIR attribute

Description: Validation information for out parameters

FHIR Version: r4

Attribute Type : canonical(StructureDefinition)

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"outputProfile":

Learn more about the (OperationDefinition) outputProfile FHIR attribute

Description: Parameters for the operation/query

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"parameter": [
  {
    "name": "subject",
    "use": "in",
    "min": 1,
    "max": "1",
    "documentation": "The resource that is to be the *QuestionnaireResponse.subject*. The [[[QuestionnaireResponse]]]      instance will reference the provided subject.  In addition, if the *local* parameter is      set to true, server information about the specified subject will be used to populate the      instance.",
    "type": "Reference"
  },
  {
    "name": "local",
    "use": "in",
    "min": 0,
    "max": "1",
    "documentation": "If the *local* parameter is set to true, server information about the specified subject will be used to populate the instance.",
    "type": "Reference"
  },
  {
    "name": "return",
    "use": "out",
    "min": 1,
    "max": "1",
    "documentation": "The partially (or fully)-populated set of answers for the specified Questionnaire",
    "type": "QuestionnaireResponse"
  }
]

Learn more about the (OperationDefinition) parameter FHIR attribute

Description: Define overloaded variants for when generating code

FHIR Version: r4

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"overload": [
  {
    "parameterName": [
      "subject",
      "local"
    ]
  },
  {
    "parameterName": [
      "subject"
    ],
    "comment": "local defaults to false when not passed as a parameter"
  }
]

Learn more about the (OperationDefinition) overload FHIR attribute