operation definitions

Create Operation Definition

post
/organizations/{organizationId}/fhir/4/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/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a OperationDefinition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
urluriAn absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.
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.
titlestringA short, descriptive, user-friendly title for the operation definition.
statusdraft|active|retired|unknownThe status of this operation definition. Enables tracking the life-cycle of the content.
kindoperation|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.
datedateTimeThe date (and optionally time) when the operation definition was published. The date must change 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 organization or individual that published the operation definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionmarkdownA 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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and 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.
purposemarkdownExplanation of why this operation definition is needed and why it has been designed as it has.
affectsStatebooleanWhether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
codecodeThe name used to invoke the operation.
commentmarkdownAdditional information about how to use this operation or named query.
basecanonicalIndicates that this operation definition is a constraining profile on the base.
resourcearray(code)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.
inputProfilecanonicalAdditional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.
outputProfilecanonicalAdditional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
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/4/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*This is a OperationDefinition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
urluriAn absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.
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.
titlestringA short, descriptive, user-friendly title for the operation definition.
statusdraft|active|retired|unknownThe status of this operation definition. Enables tracking the life-cycle of the content.
kindoperation|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.
datedateTimeThe date (and optionally time) when the operation definition was published. The date must change 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 organization or individual that published the operation definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionmarkdownA 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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and 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.
purposemarkdownExplanation of why this operation definition is needed and why it has been designed as it has.
affectsStatebooleanWhether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
codecodeThe name used to invoke the operation.
commentmarkdownAdditional information about how to use this operation or named query.
basecanonicalIndicates that this operation definition is a constraining profile on the base.
resourcearray(code)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.
inputProfilecanonicalAdditional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.
outputProfilecanonicalAdditional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
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/4/OperationDefinition/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Operation Definition

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/OperationDefinition/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Operation Definition

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Operation Definition

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

Request

Headers

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

Query params

_idstring
_languagestring
basestring
codestring
contextstring
context-quantitystring
context-typestring
context-type-quantitystring
context-type-valuestring
datestring
descriptionstring
input-profilestring
instancestring
jurisdictionstring
kindstring
namestring
output-profilestring
publisherstring
statusstring
systemstring
titlestring
typestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Operation Definition

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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
contextstring
context-quantitystring
context-typestring
context-type-quantitystring
context-type-valuestring
datestring
descriptionstring
input-profilestring
instancestring
jurisdictionstring
kindstring
namestring
output-profilestring
publisherstring
statusstring
systemstring
titlestring
typestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a OperationDefinition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
urluriAn absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.
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.
titlestringA short, descriptive, user-friendly title for the operation definition.
statusdraft|active|retired|unknownThe status of this operation definition. Enables tracking the life-cycle of the content.
kindoperation|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.
datedateTimeThe date (and optionally time) when the operation definition was published. The date must change 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 organization or individual that published the operation definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionmarkdownA 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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and 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.
purposemarkdownExplanation of why this operation definition is needed and why it has been designed as it has.
affectsStatebooleanWhether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
codecodeThe name used to invoke the operation.
commentmarkdownAdditional information about how to use this operation or named query.
basecanonicalIndicates that this operation definition is a constraining profile on the base.
resourcearray(code)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.
inputProfilecanonicalAdditional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.
outputProfilecanonicalAdditional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
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/4/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|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a OperationDefinition resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
urluriAn absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.
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.
titlestringA short, descriptive, user-friendly title for the operation definition.
statusdraft|active|retired|unknownThe status of this operation definition. Enables tracking the life-cycle of the content.
kindoperation|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.
datedateTimeThe date (and optionally time) when the operation definition was published. The date must change 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 organization or individual that published the operation definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionmarkdownA 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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and 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.
purposemarkdownExplanation of why this operation definition is needed and why it has been designed as it has.
affectsStatebooleanWhether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
codecodeThe name used to invoke the operation.
commentmarkdownAdditional information about how to use this operation or named query.
basecanonicalIndicates that this operation definition is a constraining profile on the base.
resourcearray(code)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.
inputProfilecanonicalAdditional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.
outputProfilecanonicalAdditional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
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