activity definitions

Create Activity Definition

post
/organizations/{organizationId}/fhir/3/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/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringActivityDefinitionThis is a ActivityDefinition resource
urlstringAn absolute URI that is used to identify this activity 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 activity definition is (or will be) published. The URL SHOULD include the major version of the activity definition. For more information see [Technical and Business Versions](resource.html#versions).
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.
statusstringdraft|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.
datestringThe date (and optionally time) when the activity 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 activity definition changes.
publisherstringThe name of the individual or organization that published the activity definition.
descriptionstringA free text natural language description of the activity definition from a consumer's perspective.
purposestringExplaination of why this activity definition is needed and why it has been designed as it has.
usagestringA detailed description of how the asset is used from a clinical perspective.
approvalDatestringThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatestringThe date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
effectivePeriodPeriodThe period during which the activity definition content was or is planned to be in active use.
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 activity definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the activity definition is intended to be used.
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.
contributorarray(Contributor)A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
copyrightstringA 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.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(Reference)A reference to a Library resource containing any formal logic used by the asset.
kindstringA description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
codeCodeableConceptDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
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.
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.
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).
transformReferenceA 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 intent resource that would contain the result.

Response

Patch Activity Definition

patch
/organizations/{organizationId}/fhir/3/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*stringActivityDefinitionThis is a ActivityDefinition resource
urlstringAn absolute URI that is used to identify this activity 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 activity definition is (or will be) published. The URL SHOULD include the major version of the activity definition. For more information see [Technical and Business Versions](resource.html#versions).
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.
statusstringdraft|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.
datestringThe date (and optionally time) when the activity 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 activity definition changes.
publisherstringThe name of the individual or organization that published the activity definition.
descriptionstringA free text natural language description of the activity definition from a consumer's perspective.
purposestringExplaination of why this activity definition is needed and why it has been designed as it has.
usagestringA detailed description of how the asset is used from a clinical perspective.
approvalDatestringThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatestringThe date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
effectivePeriodPeriodThe period during which the activity definition content was or is planned to be in active use.
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 activity definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the activity definition is intended to be used.
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.
contributorarray(Contributor)A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
copyrightstringA 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.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(Reference)A reference to a Library resource containing any formal logic used by the asset.
kindstringA description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
codeCodeableConceptDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
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.
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.
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).
transformReferenceA 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 intent resource that would contain the result.

Response

Read Activity Definition

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

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

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

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

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

Request

Headers

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

Query params

_idstring
_languagestring
composed-ofstring
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/3/ActivityDefinition/_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 Activity Definition

post
/organizations/{organizationId}/fhir/3/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
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*stringActivityDefinitionThis is a ActivityDefinition resource
urlstringAn absolute URI that is used to identify this activity 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 activity definition is (or will be) published. The URL SHOULD include the major version of the activity definition. For more information see [Technical and Business Versions](resource.html#versions).
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.
statusstringdraft|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.
datestringThe date (and optionally time) when the activity 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 activity definition changes.
publisherstringThe name of the individual or organization that published the activity definition.
descriptionstringA free text natural language description of the activity definition from a consumer's perspective.
purposestringExplaination of why this activity definition is needed and why it has been designed as it has.
usagestringA detailed description of how the asset is used from a clinical perspective.
approvalDatestringThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatestringThe date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
effectivePeriodPeriodThe period during which the activity definition content was or is planned to be in active use.
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 activity definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the activity definition is intended to be used.
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.
contributorarray(Contributor)A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
copyrightstringA 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.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(Reference)A reference to a Library resource containing any formal logic used by the asset.
kindstringA description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
codeCodeableConceptDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
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.
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.
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).
transformReferenceA 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 intent resource that would contain the result.

Response

Update Activity Definition

put
/organizations/{organizationId}/fhir/3/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/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringActivityDefinitionThis is a ActivityDefinition resource
urlstringAn absolute URI that is used to identify this activity 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 activity definition is (or will be) published. The URL SHOULD include the major version of the activity definition. For more information see [Technical and Business Versions](resource.html#versions).
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.
statusstringdraft|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.
datestringThe date (and optionally time) when the activity 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 activity definition changes.
publisherstringThe name of the individual or organization that published the activity definition.
descriptionstringA free text natural language description of the activity definition from a consumer's perspective.
purposestringExplaination of why this activity definition is needed and why it has been designed as it has.
usagestringA detailed description of how the asset is used from a clinical perspective.
approvalDatestringThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
lastReviewDatestringThe date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
effectivePeriodPeriodThe period during which the activity definition content was or is planned to be in active use.
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 activity definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the activity definition is intended to be used.
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.
contributorarray(Contributor)A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
copyrightstringA 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.
relatedArtifactarray(RelatedArtifact)Related artifacts such as additional documentation, justification, or bibliographic references.
libraryarray(Reference)A reference to a Library resource containing any formal logic used by the asset.
kindstringA description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
codeCodeableConceptDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
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.
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.
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).
transformReferenceA 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 intent resource that would contain the result.

Response