R4 Draft for Comment
Clinical ReasoningThis page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| Clinical Decision Support Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
StructureDefinition for servicedefinition
{
"resourceType": "StructureDefinition",
"id": "ServiceDefinition",
"meta": {
"lastUpdated": "2017-12-20T15:52:34.818+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cds"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/ServiceDefinition",
"name": "ServiceDefinition",
"status": "draft",
"date": "2017-12-20T15:52:34+11:00",
"publisher": "Health Level Seven International (Clinical Decision Support)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/dss/index.cfm"
}
]
}
],
"description": "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.",
"fhirVersion": "3.2.0",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "ServiceDefinition",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "MetadataResource"
}
]
},
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "ServiceDefinition",
"path": "ServiceDefinition",
"short": "A description of decision support service functionality",
"definition": "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.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::reference[@value='#'])]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Definition"
},
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"id": "ServiceDefinition.id",
"path": "ServiceDefinition.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "ServiceDefinition.meta",
"path": "ServiceDefinition.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "ServiceDefinition.implicitRules",
"path": "ServiceDefinition.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "ServiceDefinition.language",
"path": "ServiceDefinition.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "ServiceDefinition.text",
"path": "ServiceDefinition.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "ServiceDefinition.contained",
"path": "ServiceDefinition.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ServiceDefinition.extension",
"path": "ServiceDefinition.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ServiceDefinition.modifierExtension",
"path": "ServiceDefinition.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ServiceDefinition.url",
"path": "ServiceDefinition.url",
"short": "Logical URI to reference this service definition (globally unique)",
"definition": "An absolute URI that is used to identify this service definition when it is referenced in a specification, model, design or an instance. This SHOULD be globally unique, and SHOULD be a literal address at which this service definition is (or will be) published.",
"comment": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe URL SHOULD include the major version of the service definition. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the service definition to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.url"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ServiceDefinition.identifier",
"path": "ServiceDefinition.identifier",
"short": "Additional identifier for the service definition",
"definition": "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.",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this service definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ServiceDefinition.version",
"path": "ServiceDefinition.version",
"short": "Business version of the service definition",
"definition": "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 sequence.",
"comment": "There may be different service definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the service definition with the format [url]|[version].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.version"
},
{
"identity": "w5",
"map": "FiveWs.version"
},
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "ServiceDefinition.name",
"path": "ServiceDefinition.name",
"short": "Name for this service definition (computer friendly)",
"definition": "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 generation.",
"comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.",
"requirements": "Support human navigation and code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ServiceDefinition.title",
"path": "ServiceDefinition.title",
"short": "Name for this service definition (human friendly)",
"definition": "A short, descriptive, user-friendly title for the service definition.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.title"
}
]
},
{
"id": "ServiceDefinition.status",
"path": "ServiceDefinition.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this service definition. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of service definitions that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired service definition without due consideration.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "ServiceDefinition.experimental",
"path": "ServiceDefinition.experimental",
"short": "For testing purposes, not real usage",
"definition": "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.",
"comment": "Allows filtering of service definition that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental service definition in production.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level service definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.experimental"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "ServiceDefinition.date",
"path": "ServiceDefinition.date",
"short": "Date this was last changed",
"definition": "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 changes.",
"comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the service definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.date"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "ServiceDefinition.publisher",
"path": "ServiceDefinition.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the individual or organization that published the service definition.",
"comment": "Usually an organization, but may be an individual. The publisher (or steward) of the service definition is the organization or individual primarily responsible for the maintenance and upkeep of the service definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the service definition. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the service definition. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.publisher"
},
{
"identity": "w5",
"map": "FiveWs.witness"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "ServiceDefinition.description",
"path": "ServiceDefinition.description",
"short": "Natural language description of the service definition",
"definition": "A free text natural language description of the service definition from a consumer's perspective.",
"comment": "This description can be used to capture details such as why the service definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the service definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.description"
}
]
},
{
"id": "ServiceDefinition.purpose",
"path": "ServiceDefinition.purpose",
"short": "Why this service definition is defined",
"definition": "Explaination of why this service definition is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the service definition Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this service definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.purpose"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "ServiceDefinition.usage",
"path": "ServiceDefinition.usage",
"short": "Describes the clinical usage of the module",
"definition": "A detailed description of how the module is used from a clinical perspective.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ServiceDefinition.approvalDate",
"path": "ServiceDefinition.approvalDate",
"short": "When the service definition was approved by publisher",
"definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment": "The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.approvalDate"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ServiceDefinition.lastReviewDate",
"path": "ServiceDefinition.lastReviewDate",
"short": "When the service definition was last reviewed",
"definition": "The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.",
"comment": "If specified, this is usually after the approval date.",
"requirements": "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.lastReviewDate"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ServiceDefinition.effectivePeriod",
"path": "ServiceDefinition.effectivePeriod",
"short": "When the service definition is expected to be used",
"definition": "The period during which the service definition content was or is planned to be in active use.",
"comment": "The effective period for a service definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements": "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the service definition are or are expected to be used instead.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.effectivePeriod"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ServiceDefinition.useContext",
"path": "ServiceDefinition.useContext",
"short": "Context the content is intended to support",
"definition": "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.",
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.useContext"
}
]
},
{
"id": "ServiceDefinition.jurisdiction",
"path": "ServiceDefinition.jurisdiction",
"short": "Intended jurisdiction for service definition (if applicable)",
"definition": "A legal or geographic region in which the service definition is intended to be used.",
"comment": "It may be possible for the service definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.jurisdiction"
}
]
},
{
"id": "ServiceDefinition.topic",
"path": "ServiceDefinition.topic",
"short": "E.g. Education, Treatment, Assessment, etc",
"definition": "Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.",
"requirements": "Repositories must be able to determine how to categorize the module so that it can be found by topical searches.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DefinitionTopic"
}
],
"strength": "example",
"description": "High-level categorization of the definition, used for searching, sorting, and filtering",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/definition-topic"
}
}
},
{
"id": "ServiceDefinition.contributor",
"path": "ServiceDefinition.contributor",
"short": "A content contributor",
"definition": "A contributor to the content of the module, including authors, editors, reviewers, and endorsers.",
"requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the knowledge module.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contributor"
}
]
},
{
"id": "ServiceDefinition.contact",
"path": "ServiceDefinition.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.contact"
}
]
},
{
"id": "ServiceDefinition.copyright",
"path": "ServiceDefinition.copyright",
"short": "Use and/or publishing restrictions",
"definition": "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 definition.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the service definition and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.copyright"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ServiceDefinition.relatedArtifact",
"path": "ServiceDefinition.relatedArtifact",
"short": "Additional documentation, citations, etc",
"definition": "Related resources such as additional documentation, justification, or bibliographic references.",
"comment": "Each related resource is either an attachment, or a reference to another resource, but not both.",
"requirements": "Modules must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min": 0,
"max": "*",
"type": [
{
"code": "RelatedArtifact"
}
]
},
{
"id": "ServiceDefinition.trigger",
"path": "ServiceDefinition.trigger",
"short": "\"when\" the module should be invoked",
"definition": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "TriggerDefinition"
}
]
},
{
"id": "ServiceDefinition.dataRequirement",
"path": "ServiceDefinition.dataRequirement",
"short": "What data is used by the module",
"definition": "Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation.",
"min": 0,
"max": "*",
"type": [
{
"code": "DataRequirement"
}
]
},
{
"id": "ServiceDefinition.operationDefinition",
"path": "ServiceDefinition.operationDefinition",
"short": "Operation to invoke",
"definition": "A reference to the operation that is used to invoke this service.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/OperationDefinition"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ServiceDefinition",
"path": "ServiceDefinition",
"short": "A description of decision support service functionality",
"definition": "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.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "workflow",
"map": "Definition"
},
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"id": "ServiceDefinition.url",
"path": "ServiceDefinition.url",
"short": "Logical URI to reference this service definition (globally unique)",
"definition": "An absolute URI that is used to identify this service definition when it is referenced in a specification, model, design or an instance. This SHOULD be globally unique, and SHOULD be a literal address at which this service definition is (or will be) published.",
"comment": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe URL SHOULD include the major version of the service definition. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the service definition to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.url"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ServiceDefinition.identifier",
"path": "ServiceDefinition.identifier",
"short": "Additional identifier for the service definition",
"definition": "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.",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this service definition outside of FHIR, where it is not possible to use the logical URI.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ServiceDefinition.version",
"path": "ServiceDefinition.version",
"short": "Business version of the service definition",
"definition": "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 sequence.",
"comment": "There may be different service definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the service definition with the format [url]|[version].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.version"
},
{
"identity": "w5",
"map": "FiveWs.version"
},
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "ServiceDefinition.name",
"path": "ServiceDefinition.name",
"short": "Name for this service definition (computer friendly)",
"definition": "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 generation.",
"comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.",
"requirements": "Support human navigation and code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ServiceDefinition.title",
"path": "ServiceDefinition.title",
"short": "Name for this service definition (human friendly)",
"definition": "A short, descriptive, user-friendly title for the service definition.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.title"
}
]
},
{
"id": "ServiceDefinition.status",
"path": "ServiceDefinition.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this service definition. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of service definitions that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired service definition without due consideration.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "ServiceDefinition.experimental",
"path": "ServiceDefinition.experimental",
"short": "For testing purposes, not real usage",
"definition": "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.",
"comment": "Allows filtering of service definition that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental service definition in production.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level service definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.experimental"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "ServiceDefinition.date",
"path": "ServiceDefinition.date",
"short": "Date this was last changed",
"definition": "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 changes.",
"comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the service definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.date"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "ServiceDefinition.publisher",
"path": "ServiceDefinition.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the individual or organization that published the service definition.",
"comment": "Usually an organization, but may be an individual. The publisher (or steward) of the service definition is the organization or individual primarily responsible for the maintenance and upkeep of the service definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the service definition. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the service definition. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.publisher"
},
{
"identity": "w5",
"map": "FiveWs.witness"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "ServiceDefinition.description",
"path": "ServiceDefinition.description",
"short": "Natural language description of the service definition",
"definition": "A free text natural language description of the service definition from a consumer's perspective.",
"comment": "This description can be used to capture details such as why the service definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the service definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.description"
}
]
},
{
"id": "ServiceDefinition.purpose",
"path": "ServiceDefinition.purpose",
"short": "Why this service definition is defined",
"definition": "Explaination of why this service definition is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the service definition Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this service definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.purpose"
},
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "ServiceDefinition.usage",
"path": "ServiceDefinition.usage",
"short": "Describes the clinical usage of the module",
"definition": "A detailed description of how the module is used from a clinical perspective.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ServiceDefinition.approvalDate",
"path": "ServiceDefinition.approvalDate",
"short": "When the service definition was approved by publisher",
"definition": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"comment": "The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.approvalDate"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ServiceDefinition.lastReviewDate",
"path": "ServiceDefinition.lastReviewDate",
"short": "When the service definition was last reviewed",
"definition": "The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.",
"comment": "If specified, this is usually after the approval date.",
"requirements": "Gives a sense of how \"current\" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.lastReviewDate"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ServiceDefinition.effectivePeriod",
"path": "ServiceDefinition.effectivePeriod",
"short": "When the service definition is expected to be used",
"definition": "The period during which the service definition content was or is planned to be in active use.",
"comment": "The effective period for a service definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.",
"requirements": "Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the service definition are or are expected to be used instead.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.effectivePeriod"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ServiceDefinition.useContext",
"path": "ServiceDefinition.useContext",
"short": "Context the content is intended to support",
"definition": "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.",
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.useContext"
}
]
},
{
"id": "ServiceDefinition.jurisdiction",
"path": "ServiceDefinition.jurisdiction",
"short": "Intended jurisdiction for service definition (if applicable)",
"definition": "A legal or geographic region in which the service definition is intended to be used.",
"comment": "It may be possible for the service definition to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.jurisdiction"
}
]
},
{
"id": "ServiceDefinition.topic",
"path": "ServiceDefinition.topic",
"short": "E.g. Education, Treatment, Assessment, etc",
"definition": "Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.",
"requirements": "Repositories must be able to determine how to categorize the module so that it can be found by topical searches.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DefinitionTopic"
}
],
"strength": "example",
"description": "High-level categorization of the definition, used for searching, sorting, and filtering",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/definition-topic"
}
}
},
{
"id": "ServiceDefinition.contributor",
"path": "ServiceDefinition.contributor",
"short": "A content contributor",
"definition": "A contributor to the content of the module, including authors, editors, reviewers, and endorsers.",
"requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the knowledge module.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contributor"
}
]
},
{
"id": "ServiceDefinition.contact",
"path": "ServiceDefinition.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.contact"
}
]
},
{
"id": "ServiceDefinition.copyright",
"path": "ServiceDefinition.copyright",
"short": "Use and/or publishing restrictions",
"definition": "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 definition.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the service definition and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.copyright"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ServiceDefinition.relatedArtifact",
"path": "ServiceDefinition.relatedArtifact",
"short": "Additional documentation, citations, etc",
"definition": "Related resources such as additional documentation, justification, or bibliographic references.",
"comment": "Each related resource is either an attachment, or a reference to another resource, but not both.",
"requirements": "Modules must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.",
"min": 0,
"max": "*",
"type": [
{
"code": "RelatedArtifact"
}
]
},
{
"id": "ServiceDefinition.trigger",
"path": "ServiceDefinition.trigger",
"short": "\"when\" the module should be invoked",
"definition": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "TriggerDefinition"
}
]
},
{
"id": "ServiceDefinition.dataRequirement",
"path": "ServiceDefinition.dataRequirement",
"short": "What data is used by the module",
"definition": "Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation.",
"min": 0,
"max": "*",
"type": [
{
"code": "DataRequirement"
}
]
},
{
"id": "ServiceDefinition.operationDefinition",
"path": "ServiceDefinition.operationDefinition",
"short": "Operation to invoke",
"definition": "A reference to the operation that is used to invoke this service.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/OperationDefinition"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Release 4 Draft for Comment (Jan-2018 v3.2.0-12885) generated on Wed, Dec 20, 2017 15:58+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change