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 Attribute Name: parameter
Description: Parameters for the operation/query
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 Attribute Field is list Type Description
url
false
uri
Canonical identifier for this operation definition, represented as a URI (globally unique)
Description: Canonical identifier for this operation definition, represented as a URI (globally unique)
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"
version
false
string
Business version of the operation definition
Description: Business version of the operation definition
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
name
false
string
C? Name for this operation definition (computer friendly)
Description: C? Name for this operation definition (computer friendly)
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"
title
false
string
Name for this operation definition (human friendly)
Description: Name for this operation definition (human friendly)
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
status
false
code
draft | active | retired | unknown
Description: draft | active | retired | unknown
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example: "status": "draft"
kind
false
code
operation | query
Description: operation | query
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example: "kind": "operation"
experimental
false
boolean
For testing purposes, not real usage
Description: For testing purposes, not real usage
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
date
false
dateTime
Date last changed
Description: Date last changed
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"
publisher
false
string
Name of the publisher (organization or individual)
Description: Name of the publisher (organization or individual)
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"
contact
true
ContactDetail
Contact details for the publisher
Description: Contact details for the publisher
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"
}
]
}
]
description
false
markdown
Natural language description of the operation definition
Description: Natural language description of the operation definition
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"
useContext
true
UsageContext
The context that the content is intended to support
Description: The context that the content is intended to support
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"
}
]
}
}
]
jurisdiction
true
CodeableConcept
Intended jurisdiction for operation definition (if applicable)
Description: Intended jurisdiction for operation definition (if applicable)
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)"
}
]
}
]
purpose
false
markdown
Why this operation definition is defined
Description: Why this operation definition is defined
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
affectsState
false
boolean
Whether content is changed by the operation
Description: Whether content is changed by the operation
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
code
false
code
Name used to invoke the operation
Description: Name used to invoke the operation
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example: "code": "populate"
comment
false
markdown
Additional information about use
Description: Additional information about use
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"
base
false
canonical(OperationDefinition)
Marks this as a profile of the base
Description: Marks this as a profile of the base
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"
resource
true
code
Types this operation applies to
Description: Types this operation applies to
Attribute Type : code
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example: "resource": [
"Questionnaire"
]
system
false
boolean
Invoke at the system level?
Description: Invoke at the system level?
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
type
false
boolean
Invoke at the type level?
Description: Invoke at the type level?
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
instance
false
boolean
Invoke on an instance?
Description: Invoke on an instance?
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
inputProfile
false
canonical(StructureDefinition)
Validation information for in parameters
Description: Validation information for in parameters
Attribute Type : canonical(StructureDefinition)
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
outputProfile
false
canonical(StructureDefinition)
Validation information for out parameters
Description: Validation information for out parameters
Attribute Type : canonical(StructureDefinition)
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
parameter
true
Data Type
Parameters for the operation/query
Description: Parameters for the operation/query
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"
}
]
overload
true
Data Type
Define overloaded variants for when generating code
Description: Define overloaded variants for when generating code
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"
}
]