activity definitions

Create Activity Definition

post
/organizations/{organizationId}/fhir/4/ActivityDefinition

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

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 ActivityDefinition 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 activity 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 activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
identifierarray(Identifier)A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
namestringA natural language name identifying the activity 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 activity definition.
subtitlestringAn explanatory or alternate title for the activity definition giving additional information about its content.
statusdraft|active|retired|unknownThe status of this activity definition. Enables tracking the life-cycle of the content.
experimentalbooleanA Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
subjectCodeableConceptCodeableConceptA code or group definition that describes the intended subject of the activity being defined.
subjectReferenceReferenceA code or group definition that describes the intended subject of the activity being defined.
datedateTimeThe date (and optionally time) when the activity 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 activity definition changes.
publisherstringThe name of the organization or individual that published the activity definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionmarkdownA free text natural language description of the activity 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 activity definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the activity definition is intended to be used.
purposemarkdownExplanation of why this activity definition is needed and why it has been designed as it has.
usagestringA detailed description of how the activity definition is used from a clinical perspective.
copyrightmarkdownA copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
approvalDatedateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatedateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
effectivePeriodPeriodThe period during which the activity definition content was or is planned to be in active use.
topicarray(CodeableConcept)Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
authorarray(ContactDetail)An individiual or organization primarily involved in the creation and maintenance of the content.
editorarray(ContactDetail)An individual or organization primarily responsible for internal coherence of the content.
reviewerarray(ContactDetail)An individual or organization primarily responsible for review of some aspect of the content.
endorserarray(ContactDetail)An individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(canonical)A reference to a Library resource containing any formal logic used by the activity definition.
kindcodeA description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
profilecanonicalA profile to which the target of the activity definition is expected to conform.
codeCodeableConceptDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
intentcodeIndicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
prioritycodeIndicates how quickly the activity should be addressed with respect to other requests.
doNotPerformbooleanSet this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
timingTimingTimingThe period, timing or frequency upon which the described activity is to occur.
timingDateTimestringThe period, timing or frequency upon which the described activity is to occur.
timingAgeAgeThe period, timing or frequency upon which the described activity is to occur.
timingPeriodPeriodThe period, timing or frequency upon which the described activity is to occur.
timingRangeRangeThe period, timing or frequency upon which the described activity is to occur.
timingDurationDurationThe period, timing or frequency upon which the described activity is to occur.
locationReferenceIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
participantarray(ActivityDefinition_Participant)Indicates who should participate in performing the action described.
productReferenceReferenceIdentifies the food, drug or other product being consumed or supplied in the activity.
productCodeableConceptCodeableConceptIdentifies the food, drug or other product being consumed or supplied in the activity.
quantityQuantityIdentifies the quantity expected to be consumed at once (per dose, per meal, etc.).
dosagearray(Dosage)Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
bodySitearray(CodeableConcept)Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
specimenRequirementarray(Reference)Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
observationRequirementarray(Reference)Defines observation requirements for the action to be performed, such as body weight or surface area.
observationResultRequirementarray(Reference)Defines the observations that are expected to be produced by the action.
transformcanonicalA reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
dynamicValuearray(ActivityDefinition_DynamicValue)Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.

Response

Patch Activity Definition

patch
/organizations/{organizationId}/fhir/4/ActivityDefinition/{resourceId}

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

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 ActivityDefinition 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 activity 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 activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
identifierarray(Identifier)A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
namestringA natural language name identifying the activity 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 activity definition.
subtitlestringAn explanatory or alternate title for the activity definition giving additional information about its content.
statusdraft|active|retired|unknownThe status of this activity definition. Enables tracking the life-cycle of the content.
experimentalbooleanA Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
subjectCodeableConceptCodeableConceptA code or group definition that describes the intended subject of the activity being defined.
subjectReferenceReferenceA code or group definition that describes the intended subject of the activity being defined.
datedateTimeThe date (and optionally time) when the activity 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 activity definition changes.
publisherstringThe name of the organization or individual that published the activity definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionmarkdownA free text natural language description of the activity 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 activity definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the activity definition is intended to be used.
purposemarkdownExplanation of why this activity definition is needed and why it has been designed as it has.
usagestringA detailed description of how the activity definition is used from a clinical perspective.
copyrightmarkdownA copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
approvalDatedateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatedateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
effectivePeriodPeriodThe period during which the activity definition content was or is planned to be in active use.
topicarray(CodeableConcept)Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
authorarray(ContactDetail)An individiual or organization primarily involved in the creation and maintenance of the content.
editorarray(ContactDetail)An individual or organization primarily responsible for internal coherence of the content.
reviewerarray(ContactDetail)An individual or organization primarily responsible for review of some aspect of the content.
endorserarray(ContactDetail)An individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(canonical)A reference to a Library resource containing any formal logic used by the activity definition.
kindcodeA description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
profilecanonicalA profile to which the target of the activity definition is expected to conform.
codeCodeableConceptDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
intentcodeIndicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
prioritycodeIndicates how quickly the activity should be addressed with respect to other requests.
doNotPerformbooleanSet this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
timingTimingTimingThe period, timing or frequency upon which the described activity is to occur.
timingDateTimestringThe period, timing or frequency upon which the described activity is to occur.
timingAgeAgeThe period, timing or frequency upon which the described activity is to occur.
timingPeriodPeriodThe period, timing or frequency upon which the described activity is to occur.
timingRangeRangeThe period, timing or frequency upon which the described activity is to occur.
timingDurationDurationThe period, timing or frequency upon which the described activity is to occur.
locationReferenceIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
participantarray(ActivityDefinition_Participant)Indicates who should participate in performing the action described.
productReferenceReferenceIdentifies the food, drug or other product being consumed or supplied in the activity.
productCodeableConceptCodeableConceptIdentifies the food, drug or other product being consumed or supplied in the activity.
quantityQuantityIdentifies the quantity expected to be consumed at once (per dose, per meal, etc.).
dosagearray(Dosage)Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
bodySitearray(CodeableConcept)Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
specimenRequirementarray(Reference)Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
observationRequirementarray(Reference)Defines observation requirements for the action to be performed, such as body weight or surface area.
observationResultRequirementarray(Reference)Defines the observations that are expected to be produced by the action.
transformcanonicalA reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
dynamicValuearray(ActivityDefinition_DynamicValue)Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.

Response

Read Activity Definition

get
/organizations/{organizationId}/fhir/4/ActivityDefinition/{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 Activity Definition

get
/organizations/{organizationId}/fhir/4/ActivityDefinition/{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 Activity Definition

get
/organizations/{organizationId}/fhir/4/ActivityDefinition/{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 Activity Definition

delete
/organizations/{organizationId}/fhir/4/ActivityDefinition/{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 Activity Definition

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

Request

Headers

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

Query params

_idstring
_languagestring
composed-ofstring
contextstring
context-quantitystring
context-type-valuestring
datestring
depends-onstring
derived-fromstring
descriptionstring
effectivestring
identifierstring
jurisdictionstring
namestring
predecessorstring
publisherstring
statusstring
successorstring
titlestring
topicstring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Activity Definition

get
/organizations/{organizationId}/fhir/4/ActivityDefinition/_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 Activity Definition

post
/organizations/{organizationId}/fhir/4/ActivityDefinition/_search

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

Request

Headers

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

Query params

_idstring
_languagestring
composed-ofstring
contextstring
context-quantitystring
context-type-valuestring
datestring
depends-onstring
derived-fromstring
descriptionstring
effectivestring
identifierstring
jurisdictionstring
namestring
predecessorstring
publisherstring
statusstring
successorstring
titlestring
topicstring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a ActivityDefinition 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 activity 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 activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
identifierarray(Identifier)A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
namestringA natural language name identifying the activity 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 activity definition.
subtitlestringAn explanatory or alternate title for the activity definition giving additional information about its content.
statusdraft|active|retired|unknownThe status of this activity definition. Enables tracking the life-cycle of the content.
experimentalbooleanA Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
subjectCodeableConceptCodeableConceptA code or group definition that describes the intended subject of the activity being defined.
subjectReferenceReferenceA code or group definition that describes the intended subject of the activity being defined.
datedateTimeThe date (and optionally time) when the activity 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 activity definition changes.
publisherstringThe name of the organization or individual that published the activity definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionmarkdownA free text natural language description of the activity 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 activity definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the activity definition is intended to be used.
purposemarkdownExplanation of why this activity definition is needed and why it has been designed as it has.
usagestringA detailed description of how the activity definition is used from a clinical perspective.
copyrightmarkdownA copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
approvalDatedateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatedateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
effectivePeriodPeriodThe period during which the activity definition content was or is planned to be in active use.
topicarray(CodeableConcept)Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
authorarray(ContactDetail)An individiual or organization primarily involved in the creation and maintenance of the content.
editorarray(ContactDetail)An individual or organization primarily responsible for internal coherence of the content.
reviewerarray(ContactDetail)An individual or organization primarily responsible for review of some aspect of the content.
endorserarray(ContactDetail)An individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(canonical)A reference to a Library resource containing any formal logic used by the activity definition.
kindcodeA description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
profilecanonicalA profile to which the target of the activity definition is expected to conform.
codeCodeableConceptDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
intentcodeIndicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
prioritycodeIndicates how quickly the activity should be addressed with respect to other requests.
doNotPerformbooleanSet this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
timingTimingTimingThe period, timing or frequency upon which the described activity is to occur.
timingDateTimestringThe period, timing or frequency upon which the described activity is to occur.
timingAgeAgeThe period, timing or frequency upon which the described activity is to occur.
timingPeriodPeriodThe period, timing or frequency upon which the described activity is to occur.
timingRangeRangeThe period, timing or frequency upon which the described activity is to occur.
timingDurationDurationThe period, timing or frequency upon which the described activity is to occur.
locationReferenceIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
participantarray(ActivityDefinition_Participant)Indicates who should participate in performing the action described.
productReferenceReferenceIdentifies the food, drug or other product being consumed or supplied in the activity.
productCodeableConceptCodeableConceptIdentifies the food, drug or other product being consumed or supplied in the activity.
quantityQuantityIdentifies the quantity expected to be consumed at once (per dose, per meal, etc.).
dosagearray(Dosage)Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
bodySitearray(CodeableConcept)Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
specimenRequirementarray(Reference)Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
observationRequirementarray(Reference)Defines observation requirements for the action to be performed, such as body weight or surface area.
observationResultRequirementarray(Reference)Defines the observations that are expected to be produced by the action.
transformcanonicalA reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
dynamicValuearray(ActivityDefinition_DynamicValue)Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.

Response

Update Activity Definition

put
/organizations/{organizationId}/fhir/4/ActivityDefinition/{resourceId}

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

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 ActivityDefinition 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 activity 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 activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
identifierarray(Identifier)A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
namestringA natural language name identifying the activity 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 activity definition.
subtitlestringAn explanatory or alternate title for the activity definition giving additional information about its content.
statusdraft|active|retired|unknownThe status of this activity definition. Enables tracking the life-cycle of the content.
experimentalbooleanA Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
subjectCodeableConceptCodeableConceptA code or group definition that describes the intended subject of the activity being defined.
subjectReferenceReferenceA code or group definition that describes the intended subject of the activity being defined.
datedateTimeThe date (and optionally time) when the activity 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 activity definition changes.
publisherstringThe name of the organization or individual that published the activity definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionmarkdownA free text natural language description of the activity 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 activity definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the activity definition is intended to be used.
purposemarkdownExplanation of why this activity definition is needed and why it has been designed as it has.
usagestringA detailed description of how the activity definition is used from a clinical perspective.
copyrightmarkdownA copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
approvalDatedateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatedateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
effectivePeriodPeriodThe period during which the activity definition content was or is planned to be in active use.
topicarray(CodeableConcept)Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
authorarray(ContactDetail)An individiual or organization primarily involved in the creation and maintenance of the content.
editorarray(ContactDetail)An individual or organization primarily responsible for internal coherence of the content.
reviewerarray(ContactDetail)An individual or organization primarily responsible for review of some aspect of the content.
endorserarray(ContactDetail)An individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(canonical)A reference to a Library resource containing any formal logic used by the activity definition.
kindcodeA description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
profilecanonicalA profile to which the target of the activity definition is expected to conform.
codeCodeableConceptDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
intentcodeIndicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
prioritycodeIndicates how quickly the activity should be addressed with respect to other requests.
doNotPerformbooleanSet this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
timingTimingTimingThe period, timing or frequency upon which the described activity is to occur.
timingDateTimestringThe period, timing or frequency upon which the described activity is to occur.
timingAgeAgeThe period, timing or frequency upon which the described activity is to occur.
timingPeriodPeriodThe period, timing or frequency upon which the described activity is to occur.
timingRangeRangeThe period, timing or frequency upon which the described activity is to occur.
timingDurationDurationThe period, timing or frequency upon which the described activity is to occur.
locationReferenceIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
participantarray(ActivityDefinition_Participant)Indicates who should participate in performing the action described.
productReferenceReferenceIdentifies the food, drug or other product being consumed or supplied in the activity.
productCodeableConceptCodeableConceptIdentifies the food, drug or other product being consumed or supplied in the activity.
quantityQuantityIdentifies the quantity expected to be consumed at once (per dose, per meal, etc.).
dosagearray(Dosage)Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
bodySitearray(CodeableConcept)Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
specimenRequirementarray(Reference)Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
observationRequirementarray(Reference)Defines observation requirements for the action to be performed, such as body weight or surface area.
observationResultRequirementarray(Reference)Defines the observations that are expected to be produced by the action.
transformcanonicalA reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
dynamicValuearray(ActivityDefinition_DynamicValue)Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.

Response