plan definitions

Create Plan Definition

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

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringPlanDefinitionThis is a PlanDefinition resource
urlstringAn absolute URI that is used to identify this plan 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 plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this plan 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 plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan 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 artifacts.
namestringA natural language name identifying the plan 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 plan definition.
typeCodeableConceptThe type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.
statusstringdraft|active|retired|unknownThe status of this plan definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this plan 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 plan 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 plan definition changes.
publisherstringThe name of the individual or organization that published the plan definition.
descriptionstringA free text natural language description of the plan definition from a consumer's perspective.
purposestringExplaination of why this plan 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 plan 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 plan definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the plan definition is intended to be used.
topicarray(CodeableConcept)Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition 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 plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan 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 plan definition.
goalarray(PlanDefinition_Goal)Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
actionarray(PlanDefinition_Action)An action to be taken as part of the plan.

Response

Patch Plan Definition

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

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

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*stringPlanDefinitionThis is a PlanDefinition resource
urlstringAn absolute URI that is used to identify this plan 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 plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this plan 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 plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan 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 artifacts.
namestringA natural language name identifying the plan 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 plan definition.
typeCodeableConceptThe type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.
statusstringdraft|active|retired|unknownThe status of this plan definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this plan 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 plan 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 plan definition changes.
publisherstringThe name of the individual or organization that published the plan definition.
descriptionstringA free text natural language description of the plan definition from a consumer's perspective.
purposestringExplaination of why this plan 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 plan 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 plan definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the plan definition is intended to be used.
topicarray(CodeableConcept)Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition 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 plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan 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 plan definition.
goalarray(PlanDefinition_Goal)Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
actionarray(PlanDefinition_Action)An action to be taken as part of the plan.

Response

Read Plan Definition

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

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

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

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

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

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 Plan Definition

get
/organizations/{organizationId}/fhir/3/PlanDefinition/_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 Plan Definition

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

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

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*stringPlanDefinitionThis is a PlanDefinition resource
urlstringAn absolute URI that is used to identify this plan 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 plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this plan 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 plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan 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 artifacts.
namestringA natural language name identifying the plan 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 plan definition.
typeCodeableConceptThe type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.
statusstringdraft|active|retired|unknownThe status of this plan definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this plan 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 plan 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 plan definition changes.
publisherstringThe name of the individual or organization that published the plan definition.
descriptionstringA free text natural language description of the plan definition from a consumer's perspective.
purposestringExplaination of why this plan 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 plan 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 plan definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the plan definition is intended to be used.
topicarray(CodeableConcept)Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition 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 plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan 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 plan definition.
goalarray(PlanDefinition_Goal)Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
actionarray(PlanDefinition_Action)An action to be taken as part of the plan.

Response

Update Plan Definition

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

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringPlanDefinitionThis is a PlanDefinition resource
urlstringAn absolute URI that is used to identify this plan 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 plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this plan 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 plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan 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 artifacts.
namestringA natural language name identifying the plan 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 plan definition.
typeCodeableConceptThe type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.
statusstringdraft|active|retired|unknownThe status of this plan definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this plan 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 plan 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 plan definition changes.
publisherstringThe name of the individual or organization that published the plan definition.
descriptionstringA free text natural language description of the plan definition from a consumer's perspective.
purposestringExplaination of why this plan 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 plan 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 plan definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the plan definition is intended to be used.
topicarray(CodeableConcept)Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition 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 plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan 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 plan definition.
goalarray(PlanDefinition_Goal)Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
actionarray(PlanDefinition_Action)An action to be taken as part of the plan.

Response