OperationDefinition - FHIR Resource (stu3)

This OperationDefinition Resource uses the FHIR API standard for access and structure.

Validate an OperationDefinition FHIR Resource (stu3)

OperationDefinition Attributes

AttributeField is listTypeDescription

Description: Additional information about use

FHIR Version: stu3

Attribute Type : string

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: Name used to invoke the operation

FHIR Version: stu3

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: Intended jurisdiction for operation definition (if applicable)

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

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

Learn more about the (OperationDefinition) jurisdiction FHIR attribute

Description: Invoke at the system level?

FHIR Version: stu3

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: Define overloaded variants for when generating code

FHIR Version: stu3

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"
    ]
  },
  {
    "comment": "local defaults to false when not passed as a parameter",
    "parameterName": [
      "subject"
    ]
  }
]

Learn more about the (OperationDefinition) overload FHIR attribute

Description: Invoke on an instance?

FHIR Version: stu3

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: Business version of the operation definition

FHIR Version: stu3

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: Parameters for the operation/query

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"parameter": [
  {
    "use": "in",
    "name": "subject",
    "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"
  },
  {
    "use": "in",
    "name": "local",
    "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"
  },
  {
    "use": "out",
    "name": "return",
    "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: draft | active | retired | unknown

FHIR Version: stu3

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: Natural language description of the operation definition

FHIR Version: stu3

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 implemenation"

Learn more about the (OperationDefinition) description FHIR attribute

Description: Marks this as a profile of the base

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"base": {
  "reference": "OperationDefinition/Questionnaire-populate"
}

Learn more about the (OperationDefinition) base FHIR attribute

Description: Context the content is intended to support

FHIR Version: stu3

Attribute Type : UsageContext

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

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

Learn more about the (OperationDefinition) useContext FHIR attribute

Description: Why this operation definition is defined

FHIR Version: stu3

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: Date this was last changed

FHIR Version: stu3

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: stu3

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: operation | query

FHIR Version: stu3

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: Types this operation applies to

FHIR Version: stu3

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: Name for this operation definition (computer friendly)

FHIR Version: stu3

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: Logical URI to reference this operation definition (globally unique)

FHIR Version: stu3

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: Invole at the type level?

FHIR Version: stu3

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: Whether content is unchanged by the operation

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"idempotent":

Learn more about the (OperationDefinition) idempotent FHIR attribute

Description: Contact details for the publisher

FHIR Version: stu3

Attribute Type : ContactDetail

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

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

Learn more about the (OperationDefinition) contact FHIR attribute

Description: For testing purposes, not real usage

FHIR Version: stu3

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

OperationDefinition Example

{
  "comment": "Only implemented for Labs and Medications so far",
  "code": "populate",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>url</b>: <a>http://h7.org/fhir/OperationDefinition/example</a></p><p><b>version</b>: B</p><p><b>name</b>: Populate Questionnaire</p><p><b>status</b>: draft</p><p><b>kind</b>: operation</p><p><b>date</b>: 04/08/2015</p><p><b>publisher</b>: Acme Healthcare Services</p><p><b>contact</b>: </p><p><b>description</b>: Limited implementation of the Populate Questionnaire implemenation</p><p><b>useContext</b>: </p><p><b>jurisdiction</b>: United Kingdom of Great Britain and Northern Ireland (the) <span>(Details : {urn:iso:std:iso:3166 code 'GB' = 'Gabon', given as 'United Kingdom of Great Britain and Northern Ireland (the)'})</span></p><p><b>code</b>: populate</p><p><b>comment</b>: Only implemented for Labs and Medications so far</p><p><b>base</b>: <a>OperationDefinition/Questionnaire-populate</a></p><p><b>resource</b>: Questionnaire</p><p><b>system</b>: false</p><p><b>type</b>: false</p><p><b>instance</b>: true</p><blockquote><p><b>parameter</b></p><p><b>name</b>: subject</p><p><b>use</b>: in</p><p><b>min</b>: 1</p><p><b>max</b>: 1</p><p><b>documentation</b>: 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.</p><p><b>type</b>: Reference</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: local</p><p><b>use</b>: in</p><p><b>min</b>: 0</p><p><b>max</b>: 1</p><p><b>documentation</b>: If the *local* parameter is set to true, server information about the specified subject will be used to populate the instance.</p><p><b>type</b>: Reference</p></blockquote><blockquote><p><b>parameter</b></p><p><b>name</b>: return</p><p><b>use</b>: out</p><p><b>min</b>: 1</p><p><b>max</b>: 1</p><p><b>documentation</b>: The partially (or fully)-populated set of answers for the specified Questionnaire</p><p><b>type</b>: QuestionnaireResponse</p></blockquote><blockquote><p><b>overload</b></p><p><b>parameterName</b>: subject, local</p></blockquote><blockquote><p><b>overload</b></p><p><b>parameterName</b>: subject</p><p><b>comment</b>: local defaults to false when not passed as a parameter</p></blockquote></div>"
  },
  "jurisdiction": [
    {
      "coding": [
        {
          "code": "GB",
          "system": "urn:iso:std:iso:3166",
          "display": "United Kingdom of Great Britain and Northern Ireland (the)"
        }
      ]
    }
  ],
  "id": "example",
  "system": false,
  "overload": [
    {
      "parameterName": [
        "subject",
        "local"
      ]
    },
    {
      "comment": "local defaults to false when not passed as a parameter",
      "parameterName": [
        "subject"
      ]
    }
  ],
  "instance": true,
  "version": "B",
  "parameter": [
    {
      "use": "in",
      "name": "subject",
      "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"
    },
    {
      "use": "in",
      "name": "local",
      "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"
    },
    {
      "use": "out",
      "name": "return",
      "min": 1,
      "max": "1",
      "documentation": "The partially (or fully)-populated set of answers for the specified Questionnaire",
      "type": "QuestionnaireResponse"
    }
  ],
  "status": "draft",
  "description": "Limited implementation of the Populate Questionnaire implemenation",
  "base": {
    "reference": "OperationDefinition/Questionnaire-populate"
  },
  "useContext": [
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "IMP",
            "system": "http://hl7.org/fhir/v3/ActCode",
            "display": "inpatient encounter"
          }
        ]
      },
      "code": {
        "code": "venue",
        "system": "http://hl7.org/fhir/codesystem-usage-context-type",
        "display": "Clinical Venue"
      }
    }
  ],
  "date": "2015-08-04",
  "publisher": "Acme Healthcare Services",
  "kind": "operation",
  "resource": [
    "Questionnaire"
  ],
  "name": "Populate Questionnaire",
  "resourceType": "OperationDefinition",
  "type": false,
  "url": "http://h7.org/fhir/OperationDefinition/example",
  "contact": [
    {
      "telecom": [
        {
          "system": "email",
          "value": "beep@coyote.acme.com"
        }
      ],
      "name": "System Administrator"
    }
  ]
}

OperationDefinition Structure


  
{
  "resourceType" : "OperationDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this operation definition (globally unique)
  "version" : "<string>", // Business version of the operation definition
  "name" : "<string>", // R!  Name for this operation definition (computer friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "kind" : "<code>", // R!  operation | query
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the operation definition
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for operation definition (if applicable)
  "purpose" : "<markdown>", // Why this operation definition is defined
  "idempotent" : <boolean>, // Whether content is unchanged by the operation
  "code" : "<code>", // R!  Name used to invoke the operation
  "comment" : "<string>", // Additional information about use
  "base" : { Reference(OperationDefinition) }, // Marks this as a profile of the base
  "resource" : ["<code>"], // Types this operation applies to
  "system" : <boolean>, // R!  Invoke at the system level?
  "type" : <boolean>, // R!  Invole at the type level?
  "instance" : <boolean>, // R!  Invoke on an instance?
  "parameter" : [{ // Parameters for the operation/query
    "name" : "<code>", // R!  Name in Parameters.parameter.name or in URL
    "use" : "<code>", // R!  in | out
    "min" : <integer>, // R!  Minimum Cardinality
    "max" : "<string>", // R!  Maximum Cardinality (a number or *)
    "documentation" : "<string>", // Description of meaning/use
    "type" : "<code>", // C? What type this parameter has
    "searchType" : "<code>", // C? number | date | string | token | reference | composite | quantity | uri
    "profile" : { Reference(StructureDefinition) }, // Profile on the type
    "binding" : { // ValueSet details if this is coded
      "strength" : "<code>", // R!  required | extensible | preferred | example
      // valueSet[x]: Source of value set. One of these 2:
      "valueSetUri" : "<uri>"
      "valueSetReference" : { Reference(ValueSet) }
    },
    "part" : [{ Content as for OperationDefinition.parameter }] // C? Parts of a nested Parameter
  }],
  "overload" : [{ // Define overloaded variants for when  generating code
    "parameterName" : ["<string>"], // Name of parameter to include in overload
    "comment" : "<string>" // Comments to go on overload
  }]
}

OperationDefinition Search Parameters

The following search parameters can be used to query OperationDefinition resources. Just submit them like so:

https://api.1up.health/fhir/stu3/OperationDefinition?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`base`	`reference`	`base`
`code`	`text`	`code`
`date`	`date`	`date`
`description`	`text`	`description`
`instance`	`text`	`instance`
`jurisdiction`	`text`	`jurisdiction`
`kind`	`text`	`kind`
`name`	`text`	`name`
`param-profile`	`reference`	`parameter.profile`
`publisher`	`text`	`publisher`
`status`	`text`	`status`
`system`	`text`	`system`
`type`	`text`	`type`
`url`	`uri`	`url`
`version`	`text`	`version`