OperationDefinition - FHIR Resource (dstu2)


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

Validate an OperationDefinition FHIR Resource (dstu2)



Resource Attributes

AttributeField is listTypeDescription
basefalseReference# Marks this as a profile of the base
codefalsecode# Name used to invoke the operation
contacttrueData Type# Contact details of the publisher
datefalsedateTime# Date for this version of the operation definition
descriptionfalsestring# Natural language description of the operation
experimentalfalseboolean# If for testing purposes, not real usage
idempotentfalseboolean# Whether content is unchanged by operation
instancefalseboolean# Invoke on an instance?
kindfalsecode# operation | query
namefalsestring# Informal name for this operation
notesfalsestring# Additional information about use
parametertrueData Type# Parameters for the operation/query
publisherfalsestring# Name of the publisher (Organization or individual)
requirementsfalsestring# Why is this needed?
statusfalsecode# draft | active | retired
systemfalseboolean# Invoke at the system level?
typetruecode# Invoke at resource level for these type
urlfalseuri# Logical URL to reference this operation definition
versionfalsestring# Logical id for this version of the operation definition

OperationDefinition Structure


  
{
  "resourceType" : "OperationDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URL to reference this operation definition
  "version" : "<string>", // Logical id for this version of the operation definition
  "name" : "<string>", // R!  Informal name for this operation
  "status" : "<code>", // R!  draft | active | retired
  "kind" : "<code>", // R!  operation | query
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ // Contact details of the publisher
    "name" : "<string>", // Name of a individual to contact
    "telecom" : [{ ContactPoint }] // Contact details for individual or publisher
  }],
  "date" : "<dateTime>", // Date for this version of the operation definition
  "description" : "<string>", // Natural language description of the operation
  "requirements" : "<string>", // Why is this needed?
  "idempotent" : <boolean>, // Whether content is unchanged by operation
  "code" : "<code>", // R!  Name used to invoke the operation
  "notes" : "<string>", // Additional information about use
  "base" : { Reference(OperationDefinition) }, // Marks this as a profile of the base
  "system" : <boolean>, // R!  Invoke at the system level?
  "type" : ["<code>"], // Invoke at resource level for these type
  "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
    "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 Tuple Parameter
  }]
}


 

OperationDefinition Search Parameters

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

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