FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.2 Resource ServiceDefinition - Content

Clinical Decision Support Work GroupMaturity Level: 0 DraftCompartments: Not linked to any defined compartments

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.

14.2.1 Scope and Usage

This resource is a definition resource from a FHIR workflow perspective - see Workflow, specifically Definition.

The ServiceDefinition defines a module of clinical decision support functionality made available by a decision support service. For example, a service may provide immunization modules, drug-drug interaction checking, or appropriate use assessment.

Each module defines three main features related to its functionality:

  • Input and output parameters
  • Data requirements
  • Triggers

Input and output parameters are used to specify any named parameters used by the module. These are typically patient-independent configuration parameters such as an A1C threshold for a diabetes control module, but they may also be used to return calculations performed by the module.

Data requirements are used to specify the set of data that must be provided (or available) to the module in order to achieve a successful evaluation. For example, if the module requires A1C lab results within the last 6 months, or information on bilateral or both left and right amputation at or below the knee.

Triggers are used to advertise when the module should be invoked. On encountering a specific trigger, a clinical application can invoke the modules associated with the trigger using the $evaluate operation. Any data required by the module can be sent as part of the request, and any suggested actions and other output data are returned via the GuidanceResponse resource.

For a more detailed discussion of the evaluation process, refer to the Clinical Decision Support topic in the Clinical Reasoning module.

Note to implementers: The user-facing external clinical decision support use case supported by the ServiceDefinition/$evaluate operation of the Clinical Reasoning module has significant overlap with the functionality provided by the CDS Hooks specification. As part of FHIR Release 4, it is the intention to unify the CDS Hooks specification with the Clinical Reasoning module, ensuring that implementers have a single consistent mechanism to support this use case that meets the requirements of both the Clinical Quality Framework and CDS Hooks communities. Although the functionality in both specifications is conceptually aligned, this unification will likely result in changes to both specifications. The CQF and CDS Hooks project teams are committed to this unification and will work to ensure that the resulting changes have as little impact as possible on current and ongoing implementation efforts, while meeting the needs of both communities. The project team is planning on a workable implementation tested at the connectathon in May of 2017, with a trial ballot following in September 2017, targeting publication as part of the FHIR Release 4 specification.

14.2.2 Boundaries and Relationships

The ServiceDefinition is similar in structure and purpose to OperationDefinition. However, ServiceDefinition also represents more information about what service is being described than an operation definition supports. This information is critical to the effective use of the resource as part of a decision support service repository, as it enables searching and selection of functionality based on this additional information.

In addition, the way the $evaluate operation of the ServiceDefinition resource is defined enables all decision support services to share a common set of parameters without having to redeclare them for every module, while still supporting service-specific paramters on each module.

This resource is referenced by guidanceresponse

14.2.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceDefinition DomainResourceA description of decision support service functionality
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriLogical URI to reference this service definition (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the service definition
... version Σ0..1stringBusiness version of the service definition
... name Σ0..1stringName for this service definition (computer friendly)
... title Σ0..1stringName for this service definition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description 0..1markdownNatural language description of the service definition
... purpose 0..1markdownWhy this service definition is defined
... usage 0..1stringDescribes the clinical usage of the module
... approvalDate 0..1dateWhen the service definition was approved by publisher
... lastReviewDate 0..1dateWhen the service definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the service definition is expected to be used
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for service definition (if applicable)
Jurisdiction ValueSet (Extensible)
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
DefinitionTopic (Example)
... contributor 0..*ContributorA content contributor
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc
... trigger 0..*TriggerDefinition"when" the module should be invoked
... dataRequirement 0..*DataRequirementWhat data is used by the module
... operationDefinition 0..1Reference(OperationDefinition)Operation to invoke

doco Documentation for this format

UML Diagram (Legend)

ServiceDefinition (DomainResource)An 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)url : uri [0..1]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 artifactsidentifier : Identifier [0..*]The 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 sequenceversion : string [0..1]A 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 generationname : string [0..1]A short, descriptive, user-friendly title for the service definitiontitle : string [0..1]The status of this service definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! A 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 (this element modifies the meaning of other elements)experimental : boolean [0..1]The 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 changesdate : dateTime [0..1]The name of the individual or organization that published the service definitionpublisher : string [0..1]A free text natural language description of the service definition from a consumer's perspectivedescription : markdown [0..1]Explaination of why this service definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the module is used from a clinical perspectiveusage : string [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval datelastReviewDate : date [0..1]The period during which the service definition content was or is planned to be in active useeffectivePeriod : Period [0..1]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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the service definition is intended to be usedjurisdiction : CodeableConcept [0..*] Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searchingtopic : CodeableConcept [0..*] High-level categorization of the definition, used for searching, sorting, and filtering (Strength=Example)DefinitionTopic?? A contributor to the content of the module, including authors, editors, reviewers, and endorserscontributor : Contributor [0..*]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A 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 definitioncopyright : markdown [0..1]Related resources such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]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 workflowtrigger : TriggerDefinition [0..*]Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluationdataRequirement : DataRequirement [0..*]A reference to the operation that is used to invoke this serviceoperationDefinition : Reference [0..1] OperationDefinition

XML Template

<ServiceDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Logical URI to reference this service definition (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the service definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the service definition -->
 <name value="[string]"/><!-- 0..1 Name for this service definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this service definition (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <description value="[markdown]"/><!-- 0..1 Natural language description of the service definition -->
 <purpose value="[markdown]"/><!-- 0..1 Why this service definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the module -->
 <approvalDate value="[date]"/><!-- 0..1 When the service definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the service definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the service definition is expected to be used --></effectivePeriod>
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for service definition (if applicable) --></jurisdiction>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic>
 <contributor><!-- 0..* Contributor A content contributor --></contributor>
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact>
 <trigger><!-- 0..* TriggerDefinition "when" the module should be invoked --></trigger>
 <dataRequirement><!-- 0..* DataRequirement What data is used by the module --></dataRequirement>
 <operationDefinition><!-- 0..1 Reference(OperationDefinition) Operation to invoke --></operationDefinition>
</ServiceDefinition>

JSON Template

{doco
  "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
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ServiceDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ServiceDefinition.url [ uri ]; # 0..1 Logical URI to reference this service definition (globally unique)
  fhir:ServiceDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the service definition
  fhir:ServiceDefinition.version [ string ]; # 0..1 Business version of the service definition
  fhir:ServiceDefinition.name [ string ]; # 0..1 Name for this service definition (computer friendly)
  fhir:ServiceDefinition.title [ string ]; # 0..1 Name for this service definition (human friendly)
  fhir:ServiceDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ServiceDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ServiceDefinition.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:ServiceDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ServiceDefinition.description [ markdown ]; # 0..1 Natural language description of the service definition
  fhir:ServiceDefinition.purpose [ markdown ]; # 0..1 Why this service definition is defined
  fhir:ServiceDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the module
  fhir:ServiceDefinition.approvalDate [ date ]; # 0..1 When the service definition was approved by publisher
  fhir:ServiceDefinition.lastReviewDate [ date ]; # 0..1 When the service definition was last reviewed
  fhir:ServiceDefinition.effectivePeriod [ Period ]; # 0..1 When the service definition is expected to be used
  fhir:ServiceDefinition.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:ServiceDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for service definition (if applicable)
  fhir:ServiceDefinition.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc
  fhir:ServiceDefinition.contributor [ Contributor ], ... ; # 0..* A content contributor
  fhir:ServiceDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ServiceDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ServiceDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc
  fhir:ServiceDefinition.trigger [ TriggerDefinition ], ... ; # 0..* "when" the module should be invoked
  fhir:ServiceDefinition.dataRequirement [ DataRequirement ], ... ; # 0..* What data is used by the module
  fhir:ServiceDefinition.operationDefinition [ Reference(OperationDefinition) ]; # 0..1 Operation to invoke
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceDefinition DomainResourceA description of decision support service functionality
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriLogical URI to reference this service definition (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the service definition
... version Σ0..1stringBusiness version of the service definition
... name Σ0..1stringName for this service definition (computer friendly)
... title Σ0..1stringName for this service definition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... description 0..1markdownNatural language description of the service definition
... purpose 0..1markdownWhy this service definition is defined
... usage 0..1stringDescribes the clinical usage of the module
... approvalDate 0..1dateWhen the service definition was approved by publisher
... lastReviewDate 0..1dateWhen the service definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the service definition is expected to be used
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for service definition (if applicable)
Jurisdiction ValueSet (Extensible)
... topic 0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
DefinitionTopic (Example)
... contributor 0..*ContributorA content contributor
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc
... trigger 0..*TriggerDefinition"when" the module should be invoked
... dataRequirement 0..*DataRequirementWhat data is used by the module
... operationDefinition 0..1Reference(OperationDefinition)Operation to invoke

doco Documentation for this format

UML Diagram (Legend)

ServiceDefinition (DomainResource)An 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)url : uri [0..1]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 artifactsidentifier : Identifier [0..*]The 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 sequenceversion : string [0..1]A 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 generationname : string [0..1]A short, descriptive, user-friendly title for the service definitiontitle : string [0..1]The status of this service definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! A 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 (this element modifies the meaning of other elements)experimental : boolean [0..1]The 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 changesdate : dateTime [0..1]The name of the individual or organization that published the service definitionpublisher : string [0..1]A free text natural language description of the service definition from a consumer's perspectivedescription : markdown [0..1]Explaination of why this service definition is needed and why it has been designed as it haspurpose : markdown [0..1]A detailed description of how the module is used from a clinical perspectiveusage : string [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval datelastReviewDate : date [0..1]The period during which the service definition content was or is planned to be in active useeffectivePeriod : Period [0..1]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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the service definition is intended to be usedjurisdiction : CodeableConcept [0..*] Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searchingtopic : CodeableConcept [0..*] High-level categorization of the definition, used for searching, sorting, and filtering (Strength=Example)DefinitionTopic?? A contributor to the content of the module, including authors, editors, reviewers, and endorserscontributor : Contributor [0..*]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A 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 definitioncopyright : markdown [0..1]Related resources such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]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 workflowtrigger : TriggerDefinition [0..*]Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluationdataRequirement : DataRequirement [0..*]A reference to the operation that is used to invoke this serviceoperationDefinition : Reference [0..1] OperationDefinition

XML Template

<ServiceDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Logical URI to reference this service definition (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the service definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the service definition -->
 <name value="[string]"/><!-- 0..1 Name for this service definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this service definition (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <description value="[markdown]"/><!-- 0..1 Natural language description of the service definition -->
 <purpose value="[markdown]"/><!-- 0..1 Why this service definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the module -->
 <approvalDate value="[date]"/><!-- 0..1 When the service definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the service definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the service definition is expected to be used --></effectivePeriod>
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for service definition (if applicable) --></jurisdiction>
 <topic><!-- 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic>
 <contributor><!-- 0..* Contributor A content contributor --></contributor>
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc --></relatedArtifact>
 <trigger><!-- 0..* TriggerDefinition "when" the module should be invoked --></trigger>
 <dataRequirement><!-- 0..* DataRequirement What data is used by the module --></dataRequirement>
 <operationDefinition><!-- 0..1 Reference(OperationDefinition) Operation to invoke --></operationDefinition>
</ServiceDefinition>

JSON Template

{doco
  "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
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ServiceDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ServiceDefinition.url [ uri ]; # 0..1 Logical URI to reference this service definition (globally unique)
  fhir:ServiceDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the service definition
  fhir:ServiceDefinition.version [ string ]; # 0..1 Business version of the service definition
  fhir:ServiceDefinition.name [ string ]; # 0..1 Name for this service definition (computer friendly)
  fhir:ServiceDefinition.title [ string ]; # 0..1 Name for this service definition (human friendly)
  fhir:ServiceDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ServiceDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ServiceDefinition.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:ServiceDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ServiceDefinition.description [ markdown ]; # 0..1 Natural language description of the service definition
  fhir:ServiceDefinition.purpose [ markdown ]; # 0..1 Why this service definition is defined
  fhir:ServiceDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the module
  fhir:ServiceDefinition.approvalDate [ date ]; # 0..1 When the service definition was approved by publisher
  fhir:ServiceDefinition.lastReviewDate [ date ]; # 0..1 When the service definition was last reviewed
  fhir:ServiceDefinition.effectivePeriod [ Period ]; # 0..1 When the service definition is expected to be used
  fhir:ServiceDefinition.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:ServiceDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for service definition (if applicable)
  fhir:ServiceDefinition.topic [ CodeableConcept ], ... ; # 0..* E.g. Education, Treatment, Assessment, etc
  fhir:ServiceDefinition.contributor [ Contributor ], ... ; # 0..* A content contributor
  fhir:ServiceDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ServiceDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ServiceDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc
  fhir:ServiceDefinition.trigger [ TriggerDefinition ], ... ; # 0..* "when" the module should be invoked
  fhir:ServiceDefinition.dataRequirement [ DataRequirement ], ... ; # 0..* What data is used by the module
  fhir:ServiceDefinition.operationDefinition [ Reference(OperationDefinition) ]; # 0..1 Operation to invoke
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

14.2.3.1 Terminology Bindings

PathDefinitionTypeReference
ServiceDefinition.status The lifecycle status of a Value Set or Concept Map.RequiredPublicationStatus
ServiceDefinition.jurisdiction Countries and regions within which this artifact is targeted for useExtensibleJurisdiction ValueSet
ServiceDefinition.topic High-level categorization of the definition, used for searching, sorting, and filteringExampleDefinitionTopic

14.2.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
composed-ofreferenceWhat resource is being referencedServiceDefinition.relatedArtifact.where(type='composed-of').resource
(Any)
datedateThe service definition publication dateServiceDefinition.date
depends-onreferenceWhat resource is being referencedServiceDefinition.relatedArtifact.where(type='depends-on').resource
(Any)
derived-fromreferenceWhat resource is being referencedServiceDefinition.relatedArtifact.where(type='derived-from').resource
(Any)
descriptionstringThe description of the service definitionServiceDefinition.description
effectivedateThe time during which the service definition is intended to be in useServiceDefinition.effectivePeriod
identifiertokenExternal identifier for the service definitionServiceDefinition.identifier
jurisdictiontokenIntended jurisdiction for the service definitionServiceDefinition.jurisdiction
namestringComputationally friendly name of the service definitionServiceDefinition.name
predecessorreferenceWhat resource is being referencedServiceDefinition.relatedArtifact.where(type='predecessor').resource
(Any)
publisherstringName of the publisher of the service definitionServiceDefinition.publisher
statustokenThe current status of the service definitionServiceDefinition.status
successorreferenceWhat resource is being referencedServiceDefinition.relatedArtifact.where(type='successor').resource
(Any)
titlestringThe human-friendly name of the service definitionServiceDefinition.title
topictokenTopics associated with the moduleServiceDefinition.topic
urluriThe uri that identifies the service definitionServiceDefinition.url
versiontokenThe business version of the service definitionServiceDefinition.version