operation definitions

Create Operation Definition

post
/organizations/{organizationId}/fhir/3/OperationDefinition

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringOperationDefinitionThis is a OperationDefinition resource
urlstringAn absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published. The URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
statusstringdraft|active|retired|unknownThe status of this operation definition. Enables tracking the life-cycle of the content.
kindstringoperation|queryWhether this is an operation or a named query.
experimentalbooleanA boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the operation definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.
publisherstringThe name of the individual or organization that published the operation definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the operation definition from a consumer's perspective.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate operation definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the operation definition is intended to be used.
purposestringExplaination of why this operation definition is needed and why it has been designed as it has.
idempotentbooleanOperations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.
codestringThe name used to invoke the operation.
commentstringAdditional information about how to use this operation or named query.
baseReferenceIndicates that this operation definition is a constraining profile on the base.
resourcearray()The types on which this operation can be executed.
systembooleanIndicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
typebooleanIndicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).
instancebooleanIndicates whether this operation can be invoked on a particular instance of one of the given types.
parameterarray(OperationDefinition_Parameter)The parameters for the operation/query.
overloadarray(OperationDefinition_Overload)Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.

Response

Patch Operation Definition

patch
/organizations/{organizationId}/fhir/3/OperationDefinition/{resourceId}

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringOperationDefinitionThis is a OperationDefinition resource
urlstringAn absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published. The URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
statusstringdraft|active|retired|unknownThe status of this operation definition. Enables tracking the life-cycle of the content.
kindstringoperation|queryWhether this is an operation or a named query.
experimentalbooleanA boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the operation definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.
publisherstringThe name of the individual or organization that published the operation definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the operation definition from a consumer's perspective.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate operation definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the operation definition is intended to be used.
purposestringExplaination of why this operation definition is needed and why it has been designed as it has.
idempotentbooleanOperations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.
codestringThe name used to invoke the operation.
commentstringAdditional information about how to use this operation or named query.
baseReferenceIndicates that this operation definition is a constraining profile on the base.
resourcearray()The types on which this operation can be executed.
systembooleanIndicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
typebooleanIndicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).
instancebooleanIndicates whether this operation can be invoked on a particular instance of one of the given types.
parameterarray(OperationDefinition_Parameter)The parameters for the operation/query.
overloadarray(OperationDefinition_Overload)Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.

Response

Read Operation Definition

get
/organizations/{organizationId}/fhir/3/OperationDefinition/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Operation Definition

get
/organizations/{organizationId}/fhir/3/OperationDefinition/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Operation Definition

get
/organizations/{organizationId}/fhir/3/OperationDefinition/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Operation Definition

delete
/organizations/{organizationId}/fhir/3/OperationDefinition/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Operation Definition

get
/organizations/{organizationId}/fhir/3/OperationDefinition

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
basestring
codestring
datestring
descriptionstring
instancestring
jurisdictionstring
kindstring
namestring
param-profilestring
publisherstring
statusstring
systemstring
typestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Operation Definition

get
/organizations/{organizationId}/fhir/3/OperationDefinition/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Operation Definition

post
/organizations/{organizationId}/fhir/3/OperationDefinition/_search

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
basestring
codestring
datestring
descriptionstring
instancestring
jurisdictionstring
kindstring
namestring
param-profilestring
publisherstring
statusstring
systemstring
typestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringOperationDefinitionThis is a OperationDefinition resource
urlstringAn absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published. The URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
statusstringdraft|active|retired|unknownThe status of this operation definition. Enables tracking the life-cycle of the content.
kindstringoperation|queryWhether this is an operation or a named query.
experimentalbooleanA boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the operation definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.
publisherstringThe name of the individual or organization that published the operation definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the operation definition from a consumer's perspective.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate operation definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the operation definition is intended to be used.
purposestringExplaination of why this operation definition is needed and why it has been designed as it has.
idempotentbooleanOperations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.
codestringThe name used to invoke the operation.
commentstringAdditional information about how to use this operation or named query.
baseReferenceIndicates that this operation definition is a constraining profile on the base.
resourcearray()The types on which this operation can be executed.
systembooleanIndicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
typebooleanIndicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).
instancebooleanIndicates whether this operation can be invoked on a particular instance of one of the given types.
parameterarray(OperationDefinition_Parameter)The parameters for the operation/query.
overloadarray(OperationDefinition_Overload)Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.

Response

Update Operation Definition

put
/organizations/{organizationId}/fhir/3/OperationDefinition/{resourceId}

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringOperationDefinitionThis is a OperationDefinition resource
urlstringAn absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published. The URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
statusstringdraft|active|retired|unknownThe status of this operation definition. Enables tracking the life-cycle of the content.
kindstringoperation|queryWhether this is an operation or a named query.
experimentalbooleanA boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the operation definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.
publisherstringThe name of the individual or organization that published the operation definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the operation definition from a consumer's perspective.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate operation definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the operation definition is intended to be used.
purposestringExplaination of why this operation definition is needed and why it has been designed as it has.
idempotentbooleanOperations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.
codestringThe name used to invoke the operation.
commentstringAdditional information about how to use this operation or named query.
baseReferenceIndicates that this operation definition is a constraining profile on the base.
resourcearray()The types on which this operation can be executed.
systembooleanIndicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
typebooleanIndicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).
instancebooleanIndicates whether this operation can be invoked on a particular instance of one of the given types.
parameterarray(OperationDefinition_Parameter)The parameters for the operation/query.
overloadarray(OperationDefinition_Overload)Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.

Response