ServiceDefinition - FHIR Resource (stu3)
This ServiceDefinition Resource uses the FHIR API standard for access and structure.
Validate an ServiceDefinition FHIR Resource (stu3)
ServiceDefinition Attributes
AttributeField is listTypeDescription
Description: Intended jurisdiction for service definition (if applicable)
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": Learn more about the (ServiceDefinition) jurisdiction FHIR attribute
Description: E.g. Education, Treatment, Assessment, etc
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"topic": [
{
"text": "Guideline Appropriate Ordering"
},
{
"text": "Appropriate Use Criteria"
}
]Learn more about the (ServiceDefinition) topic FHIR attribute
Description: A content contributor
FHIR Version: stu3
Attribute Type : Contributor
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contributor": Learn more about the (ServiceDefinition) contributor FHIR attribute
Description: Use and/or publishing restrictions
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"copyright": Learn more about the (ServiceDefinition) copyright FHIR attribute
Description: Name for this service definition (human friendly)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": "Guideline Appropriate Ordering Module"Learn more about the (ServiceDefinition) title FHIR attribute
Description: "when" the module should be invoked
FHIR Version: stu3
Attribute Type : TriggerDefinition
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"trigger": Learn more about the (ServiceDefinition) trigger FHIR attribute
Description: When the service definition was last reviewed
FHIR Version: stu3
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lastReviewDate": Learn more about the (ServiceDefinition) lastReviewDate FHIR attribute
Description: Business version of the service definition
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": "1.0.0"Learn more about the (ServiceDefinition) version FHIR attribute
Description: Describes the clinical usage of the module
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"usage": Learn more about the (ServiceDefinition) usage FHIR attribute
Description: draft | active | retired | unknown
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "draft"Learn more about the (ServiceDefinition) status FHIR attribute
Description: When the service definition was approved by publisher
FHIR Version: stu3
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"approvalDate": Learn more about the (ServiceDefinition) approvalDate FHIR attribute
Description: Natural language description of the service definition
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "Guideline appropriate ordering is used to assess appropriateness of an order given a patient, a proposed order, and a set of clinical indications."Learn more about the (ServiceDefinition) description FHIR attribute
Description: Operation to invoke
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"operationDefinition": Learn more about the (ServiceDefinition) operationDefinition FHIR attribute
Description: When the service definition is expected to be used
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"effectivePeriod": Learn more about the (ServiceDefinition) effectivePeriod FHIR attribute
Description: What data is used by the module
FHIR Version: stu3
Attribute Type : DataRequirement
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dataRequirement": Learn more about the (ServiceDefinition) dataRequirement FHIR attribute
Description: Context the content is intended to support
FHIR Version: stu3
Attribute Type : UsageContext
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": Learn more about the (ServiceDefinition) useContext FHIR attribute
Description: Why this service definition is defined
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"purpose": Learn more about the (ServiceDefinition) purpose FHIR attribute
Description: Date this was last changed
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2015-07-22"Learn more about the (ServiceDefinition) date FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": Learn more about the (ServiceDefinition) publisher FHIR attribute
Description: Name for this service definition (computer friendly)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": Learn more about the (ServiceDefinition) name FHIR attribute
Description: Logical URI to reference this service definition (globally unique)
FHIR Version: stu3
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (ServiceDefinition) url FHIR attribute
Description: Contact details for the publisher
FHIR Version: stu3
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (ServiceDefinition) contact FHIR attribute
Description: Additional documentation, citations, etc
FHIR Version: stu3
Attribute Type : RelatedArtifact
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relatedArtifact": Learn more about the (ServiceDefinition) relatedArtifact FHIR attribute
Description: Additional identifier for the service definition
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"use": "official",
"value": "guildeline-appropriate-ordering"
}
]Learn more about the (ServiceDefinition) identifier FHIR attribute
Description: For testing purposes, not real usage
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": Learn more about the (ServiceDefinition) experimental FHIR attribute
ServiceDefinition Example
{
"status": "draft",
"description": "Guideline appropriate ordering is used to assess appropriateness of an order given a patient, a proposed order, and a set of clinical indications.",
"title": "Guideline Appropriate Ordering Module",
"resourceType": "ServiceDefinition",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Id: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">ServiceDefinition/example</td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Identifier: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">\n <b>value: </b>\n <span>guildeline-appropriate-ordering</span>\n </td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Title: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">Guideline Appropriate Ordering Module</td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Status: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">draft</td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Description: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-left: 25px; padding-right: 25px;\">Guideline appropriate ordering is used to assess appropriateness of an order given a patient, a proposed order, and a set of clinical indications.</td>\n </tr>\n </table>\n <p/>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Topic: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-right: 25px;\">\n <span style=\"padding-left: 25px;\">\n <b>text: </b>\n <span>Guideline Appropriate Ordering</span>\n <br/>\n </span>\n </td>\n </tr>\n </table>\n <table class=\"grid dict\">\n <tr>\n <td>\n <b>Topic: </b>\n </td>\n </tr>\n <tr>\n <td style=\"padding-right: 25px;\">\n <span style=\"padding-left: 25px;\">\n <b>text: </b>\n <span>Appropriate Use Criteria</span>\n <br/>\n </span>\n </td>\n </tr>\n </table>\n </div>"
},
"topic": [
{
"text": "Guideline Appropriate Ordering"
},
{
"text": "Appropriate Use Criteria"
}
],
"version": "1.0.0",
"date": "2015-07-22",
"identifier": [
{
"use": "official",
"value": "guildeline-appropriate-ordering"
}
],
"id": "example"
}ServiceDefinition Structure
{
"resourceType" : "ServiceDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Logical URI to reference this service definition (globally unique)
"identifier" : [{ Identifier }], // Additional identifier for the service definition
"version" : "<string>", // Business version of the service definition
"name" : "<string>", // Name for this service definition (computer friendly)
"title" : "<string>", // Name for this service definition (human friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date this was last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"description" : "<markdown>", // Natural language description of the service definition
"purpose" : "<markdown>", // Why this service definition is defined
"usage" : "<string>", // Describes the clinical usage of the module
"approvalDate" : "<date>", // When the service definition was approved by publisher
"lastReviewDate" : "<date>", // When the service definition was last reviewed
"effectivePeriod" : { Period }, // When the service definition is expected to be used
"useContext" : [{ UsageContext }], // Context the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for service definition (if applicable)
"topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
"contributor" : [{ Contributor }], // A content contributor
"contact" : [{ ContactDetail }], // Contact details for the publisher
"copyright" : "<markdown>", // Use and/or publishing restrictions
"relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc
"trigger" : [{ TriggerDefinition }], // "when" the module should be invoked
"dataRequirement" : [{ DataRequirement }], // What data is used by the module
"operationDefinition" : { Reference(OperationDefinition) } // Operation to invoke
}
ServiceDefinition Search Parameters
The following search parameters can be used to query ServiceDefinition resources. Just submit them like so:
https://api.1up.health/fhir/stu3/ServiceDefinition?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
composed-of | reference | relatedArtifact.where |
date | date | date |
depends-on | reference | relatedArtifact.where |
derived-from | reference | relatedArtifact.where |
description | text | description |
effective | date | effectivePeriod |
identifier | text | identifier |
jurisdiction | text | jurisdiction |
name | text | name |
predecessor | reference | relatedArtifact.where |
publisher | text | publisher |
status | text | status |
successor | reference | relatedArtifact.where |
title | text | title |
topic | text | topic |
url | uri | url |
version | text | version |
