STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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.4 Resource ServiceDefinition - Content

Clinical Decision Support Work GroupMaturity Level: 0Compartments: 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.4.1 Scope and Usage

This resource is a draft proposal for use as part of an approach to Clinical Quality within FHIR, and is documented as part of the Clinical Reasoning module.

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.

14.4.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.

Ballot Note: Because of the overlap with OperationDefinition, this resource is being considered for decomposition into a ServiceDefinition resource that would support a more general description of service functionality, and a possible profile or modification of OperationDefinition to support the requirements for decision support use of an operation.

This resource is referenced by guidanceresponse

14.4.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceDefinition DomainResourceA description of decision support service functionality
... 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
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... 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 service definition approved by publisher
... lastReviewDate 0..1dateLast review date for the service definition
... effectivePeriod Σ0..1PeriodThe effective date range for the service definition
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for service definition (if applicable)
Jurisdiction ValueSet (Extensible)
... topic 0..*CodeableConceptDescriptional topics for the module
... contributor 0..*ContributorA content contributor
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact 0..*RelatedArtifactRelated resources for the module
... trigger 0..*TriggerDefinition"when" the module should be invoked
... dataRequirement 0..*DataRequirementData requirements for the module
... operationDefinition 0..1Reference(OperationDefinition)Operation to invoke

doco Documentation for this format

UML Diagram (Legend)

ServiceDefinition (DomainResource)An absolute URL 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 are orderableversion : 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 flag 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 when the business version changes, if it does, 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]A free text natural language description of the service definition from the consumer's perspectivedescription : markdown [0..1]Explains 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 asset 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 asset content was last reviewed. Review happens periodically after that, 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 effectiveeffectivePeriod : 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 of code system definitionsuseContext : UsageContext [0..*]A jurisdiction 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+ »Clinical topics related to the content of the moduletopic : CodeableConcept [0..*]A contributor to the content of the module, including authors, editors, reviewers, and endorserscontributor : Contributor [0..*]The name of the individual or organization that published the service definitionpublisher : string [0..1]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 -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <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 service definition approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the service definition -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the service definition --></effectivePeriod>
 <useContext><!-- 0..* UsageContext Content intends to support these contexts --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for service definition (if applicable) --></jurisdiction>
 <topic><!-- 0..* CodeableConcept Descriptional topics for the module --></topic>
 <contributor><!-- 0..* Contributor A content contributor --></contributor>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedArtifact><!-- 0..* RelatedArtifact Related resources for the module --></relatedArtifact>
 <trigger><!-- 0..* TriggerDefinition "when" the module should be invoked --></trigger>
 <dataRequirement><!-- 0..* DataRequirement Data requirements for 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
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "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 service definition approved by publisher
  "lastReviewDate" : "<date>", // Last review date for the service definition
  "effectivePeriod" : { Period }, // The effective date range for the service definition
  "useContext" : [{ UsageContext }], // Content intends to support these contexts
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for service definition (if applicable)
  "topic" : [{ CodeableConcept }], // Descriptional topics for the module
  "contributor" : [{ Contributor }], // A content contributor
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "relatedArtifact" : [{ RelatedArtifact }], // Related resources for the module
  "trigger" : [{ TriggerDefinition }], // "when" the module should be invoked
  "dataRequirement" : [{ DataRequirement }], // Data requirements for 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
  fhir:ServiceDefinition.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:ServiceDefinition.date [ dateTime ]; # 0..1 Date this was last changed
  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 service definition approved by publisher
  fhir:ServiceDefinition.lastReviewDate [ date ]; # 0..1 Last review date for the service definition
  fhir:ServiceDefinition.effectivePeriod [ Period ]; # 0..1 The effective date range for the service definition
  fhir:ServiceDefinition.useContext [ UsageContext ], ... ; # 0..* Content intends to support these contexts
  fhir:ServiceDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for service definition (if applicable)
  fhir:ServiceDefinition.topic [ CodeableConcept ], ... ; # 0..* Descriptional topics for the module
  fhir:ServiceDefinition.contributor [ Contributor ], ... ; # 0..* A content contributor
  fhir:ServiceDefinition.publisher [ string ]; # 0..1 Name of the publisher (Organization or individual)
  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..* Related resources for the module
  fhir:ServiceDefinition.trigger [ TriggerDefinition ], ... ; # 0..* "when" the module should be invoked
  fhir:ServiceDefinition.dataRequirement [ DataRequirement ], ... ; # 0..* Data requirements for the module
  fhir:ServiceDefinition.operationDefinition [ Reference(OperationDefinition) ]; # 0..1 Operation to invoke
]

Changes since DSTU2

This resource did not exist in Release 2

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceDefinition DomainResourceA description of decision support service functionality
... 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
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... 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 service definition approved by publisher
... lastReviewDate 0..1dateLast review date for the service definition
... effectivePeriod Σ0..1PeriodThe effective date range for the service definition
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for service definition (if applicable)
Jurisdiction ValueSet (Extensible)
... topic 0..*CodeableConceptDescriptional topics for the module
... contributor 0..*ContributorA content contributor
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... relatedArtifact 0..*RelatedArtifactRelated resources for the module
... trigger 0..*TriggerDefinition"when" the module should be invoked
... dataRequirement 0..*DataRequirementData requirements for the module
... operationDefinition 0..1Reference(OperationDefinition)Operation to invoke

doco Documentation for this format

UML Diagram (Legend)

ServiceDefinition (DomainResource)An absolute URL 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 are orderableversion : 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 flag 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 when the business version changes, if it does, 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]A free text natural language description of the service definition from the consumer's perspectivedescription : markdown [0..1]Explains 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 asset 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 asset content was last reviewed. Review happens periodically after that, 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 effectiveeffectivePeriod : 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 of code system definitionsuseContext : UsageContext [0..*]A jurisdiction 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+ »Clinical topics related to the content of the moduletopic : CodeableConcept [0..*]A contributor to the content of the module, including authors, editors, reviewers, and endorserscontributor : Contributor [0..*]The name of the individual or organization that published the service definitionpublisher : string [0..1]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 -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <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 service definition approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 Last review date for the service definition -->
 <effectivePeriod><!-- 0..1 Period The effective date range for the service definition --></effectivePeriod>
 <useContext><!-- 0..* UsageContext Content intends to support these contexts --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for service definition (if applicable) --></jurisdiction>
 <topic><!-- 0..* CodeableConcept Descriptional topics for the module --></topic>
 <contributor><!-- 0..* Contributor A content contributor --></contributor>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <relatedArtifact><!-- 0..* RelatedArtifact Related resources for the module --></relatedArtifact>
 <trigger><!-- 0..* TriggerDefinition "when" the module should be invoked --></trigger>
 <dataRequirement><!-- 0..* DataRequirement Data requirements for 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
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "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 service definition approved by publisher
  "lastReviewDate" : "<date>", // Last review date for the service definition
  "effectivePeriod" : { Period }, // The effective date range for the service definition
  "useContext" : [{ UsageContext }], // Content intends to support these contexts
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for service definition (if applicable)
  "topic" : [{ CodeableConcept }], // Descriptional topics for the module
  "contributor" : [{ Contributor }], // A content contributor
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "relatedArtifact" : [{ RelatedArtifact }], // Related resources for the module
  "trigger" : [{ TriggerDefinition }], // "when" the module should be invoked
  "dataRequirement" : [{ DataRequirement }], // Data requirements for 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
  fhir:ServiceDefinition.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:ServiceDefinition.date [ dateTime ]; # 0..1 Date this was last changed
  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 service definition approved by publisher
  fhir:ServiceDefinition.lastReviewDate [ date ]; # 0..1 Last review date for the service definition
  fhir:ServiceDefinition.effectivePeriod [ Period ]; # 0..1 The effective date range for the service definition
  fhir:ServiceDefinition.useContext [ UsageContext ], ... ; # 0..* Content intends to support these contexts
  fhir:ServiceDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for service definition (if applicable)
  fhir:ServiceDefinition.topic [ CodeableConcept ], ... ; # 0..* Descriptional topics for the module
  fhir:ServiceDefinition.contributor [ Contributor ], ... ; # 0..* A content contributor
  fhir:ServiceDefinition.publisher [ string ]; # 0..1 Name of the publisher (Organization or individual)
  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..* Related resources for the module
  fhir:ServiceDefinition.trigger [ TriggerDefinition ], ... ; # 0..* "when" the module should be invoked
  fhir:ServiceDefinition.dataRequirement [ DataRequirement ], ... ; # 0..* Data requirements for the module
  fhir:ServiceDefinition.operationDefinition [ Reference(OperationDefinition) ]; # 0..1 Operation to invoke
]

Changes since DSTU2

This resource did not exist in Release 2

 

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

14.4.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

14.4.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.

NameTypeDescriptionPathsIn Common
datedateThe service definition publication dateServiceDefinition.date
descriptionstringText search against the description of the service definitionServiceDefinition.description
effectivedateEffective time associated with the service definitionServiceDefinition.effectivePeriod
identifiertokenExternal identifiers for the service definitionServiceDefinition.identifier
jurisdictiontokenIntended jurisdiction for service definitionServiceDefinition.jurisdiction
namestringName of the service definitionServiceDefinition.name
publisherstringName of the publisher of the service definitionServiceDefinition.publisher
statustokenThe current status of the service definitionServiceDefinition.status
titlestringText search against the title of the service definitionServiceDefinition.title
topictokenTopics associated with the moduleServiceDefinition.topic
urluriThe uri that identifies the service definitionServiceDefinition.url
versiontokenThe version identifier of the service definitionServiceDefinition.version