OperationDefinition - FHIR Resource (stu3)


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

Validate an OperationDefinition FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
basefalseReference Marks this as a profile of the base
codefalsecode Name used to invoke the operation
commentfalsestring Additional information about use
contacttrueContactDetail Contact details for the publisher
datefalsedateTime Date this was last changed
descriptionfalsemarkdown Natural language description of the operation definition
experimentalfalseboolean For testing purposes, not real usage
idempotentfalseboolean Whether content is unchanged by the operation
instancefalseboolean Invoke on an instance?
jurisdictiontrueCodeableConcept Intended jurisdiction for operation definition (if applicable)
kindfalsecode operation | query
namefalsestring Name for this operation definition (computer friendly)
overloadtrueData Type Define overloaded variants for when generating code
parametertrueData Type Parameters for the operation/query
publisherfalsestring Name of the publisher (organization or individual)
purposefalsemarkdown Why this operation definition is defined
resourcetruecode Types this operation applies to
statusfalsecode draft | active | retired | unknown
systemfalseboolean Invoke at the system level?
typefalseboolean Invole at the type level?
urlfalseuri Logical URI to reference this operation definition (globally unique)
useContexttrueUsageContext Context the content is intended to support
versionfalsestring Business version of the operation definition

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 the like so:

https://api.1up.health/fhir/stu3/OperationDefinition?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
basereferencebase
codetextcode
datedatedate
descriptiontextdescription
instancetextinstance
jurisdictiontextjurisdiction
kindtextkind
nametextname
param-profilereferenceparameter.profile
publishertextpublisher
statustextstatus
systemtextsystem
typetexttype
urluriurl
versiontextversion