service definitions

Create Service Definition

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

The ServiceDefinition describes a unit of decision support functionality that is made available as a service, such as immunization modules or drug-drug interaction checking.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringServiceDefinitionThis is a ServiceDefinition resource
urlstringAn absolute URI that is used to identify this service 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 service definition is (or will be) published. The URL SHOULD include the major version of the service definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this service definition when it is represented in other formats, or referenced in a specification, model, design or an instance. This is used for CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.
versionstringThe identifier that is used to identify this version of the service definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the service definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the service 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 service definition.
statusstringdraft|active|retired|unknownThe status of this service definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this service 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 service 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 service definition changes.
publisherstringThe name of the individual or organization that published the service definition.
descriptionstringA free text natural language description of the service definition from a consumer's perspective.
purposestringExplaination of why this service definition is needed and why it has been designed as it has.
usagestringA detailed description of how the module 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 service 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 service definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the service definition is intended to be used.
topicarray(CodeableConcept)Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
contributorarray(Contributor)A contributor to the content of the module, 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 service definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the service definition.
relatedArtifactarray(RelatedArtifact)Related resources such as additional documentation, justification, or bibliographic references.
triggerarray(TriggerDefinition)The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow.
dataRequirementarray(DataRequirement)Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation.
operationDefinitionReferenceA reference to the operation that is used to invoke this service.

Response

Patch Service Definition

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

The ServiceDefinition describes a unit of decision support functionality that is made available as a service, such as immunization modules or drug-drug interaction checking.

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*stringServiceDefinitionThis is a ServiceDefinition resource
urlstringAn absolute URI that is used to identify this service 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 service definition is (or will be) published. The URL SHOULD include the major version of the service definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this service definition when it is represented in other formats, or referenced in a specification, model, design or an instance. This is used for CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.
versionstringThe identifier that is used to identify this version of the service definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the service definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the service 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 service definition.
statusstringdraft|active|retired|unknownThe status of this service definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this service 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 service 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 service definition changes.
publisherstringThe name of the individual or organization that published the service definition.
descriptionstringA free text natural language description of the service definition from a consumer's perspective.
purposestringExplaination of why this service definition is needed and why it has been designed as it has.
usagestringA detailed description of how the module 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 service 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 service definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the service definition is intended to be used.
topicarray(CodeableConcept)Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
contributorarray(Contributor)A contributor to the content of the module, 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 service definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the service definition.
relatedArtifactarray(RelatedArtifact)Related resources such as additional documentation, justification, or bibliographic references.
triggerarray(TriggerDefinition)The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow.
dataRequirementarray(DataRequirement)Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation.
operationDefinitionReferenceA reference to the operation that is used to invoke this service.

Response

Read Service Definition

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

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

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

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

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

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

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

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

The ServiceDefinition describes a unit of decision support functionality that is made available as a service, such as immunization modules or drug-drug interaction checking.

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*stringServiceDefinitionThis is a ServiceDefinition resource
urlstringAn absolute URI that is used to identify this service 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 service definition is (or will be) published. The URL SHOULD include the major version of the service definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this service definition when it is represented in other formats, or referenced in a specification, model, design or an instance. This is used for CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.
versionstringThe identifier that is used to identify this version of the service definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the service definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the service 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 service definition.
statusstringdraft|active|retired|unknownThe status of this service definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this service 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 service 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 service definition changes.
publisherstringThe name of the individual or organization that published the service definition.
descriptionstringA free text natural language description of the service definition from a consumer's perspective.
purposestringExplaination of why this service definition is needed and why it has been designed as it has.
usagestringA detailed description of how the module 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 service 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 service definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the service definition is intended to be used.
topicarray(CodeableConcept)Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
contributorarray(Contributor)A contributor to the content of the module, 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 service definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the service definition.
relatedArtifactarray(RelatedArtifact)Related resources such as additional documentation, justification, or bibliographic references.
triggerarray(TriggerDefinition)The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow.
dataRequirementarray(DataRequirement)Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation.
operationDefinitionReferenceA reference to the operation that is used to invoke this service.

Response

Update Service Definition

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

The ServiceDefinition describes a unit of decision support functionality that is made available as a service, such as immunization modules or drug-drug interaction checking.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringServiceDefinitionThis is a ServiceDefinition resource
urlstringAn absolute URI that is used to identify this service 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 service definition is (or will be) published. The URL SHOULD include the major version of the service definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this service definition when it is represented in other formats, or referenced in a specification, model, design or an instance. This is used for CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.
versionstringThe identifier that is used to identify this version of the service definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the service definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the service 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 service definition.
statusstringdraft|active|retired|unknownThe status of this service definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this service 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 service 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 service definition changes.
publisherstringThe name of the individual or organization that published the service definition.
descriptionstringA free text natural language description of the service definition from a consumer's perspective.
purposestringExplaination of why this service definition is needed and why it has been designed as it has.
usagestringA detailed description of how the module 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 service 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 service definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the service definition is intended to be used.
topicarray(CodeableConcept)Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
contributorarray(Contributor)A contributor to the content of the module, 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 service definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the service definition.
relatedArtifactarray(RelatedArtifact)Related resources such as additional documentation, justification, or bibliographic references.
triggerarray(TriggerDefinition)The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow.
dataRequirementarray(DataRequirement)Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation.
operationDefinitionReferenceA reference to the operation that is used to invoke this service.

Response