Generated Narrative: StructureDefinition profile-ServiceDefinition Name Flags Card. Type Description & Constraints Basic 0..* Basic(4.3.0) Resource for non-supported content #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:url 0..1 uri STU3: Logical URI to reference this service definition (globally unique) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.url #xD; extension:version 0..1 string STU3: Business version of the service definition (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.version #xD; extension:name 0..1 string STU3: Name for this service definition (computer friendly) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.name #xD; extension:title 0..1 string STU3: Name for this service definition (human friendly) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.title #xD; extension:date 0..1 dateTime STU3: Date this was last changed (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.date #xD; extension:publisher 0..1 string STU3: Name of the publisher (organization or individual) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.publisher #xD; extension:description 0..1 markdown STU3: Natural language description of the service definition (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.description #xD; extension:purpose 0..1 markdown STU3: Why this service definition is defined (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.purpose #xD; extension:usage 0..1 string STU3: Describes the clinical usage of the module (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.usage #xD; extension:approvalDate 0..1 date STU3: When the service definition was approved by publisher (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.approvalDate #xD; extension:lastReviewDate 0..1 date STU3: When the service definition was last reviewed (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.lastReviewDate #xD; extension:effectivePeriod 0..1 Period STU3: When the service definition is expected to be used (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.effectivePeriod #xD; extension:useContext 0..* UsageContext STU3: Context the content is intended to support (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.useContext #xD; extension:jurisdiction 0..* CodeableConcept STU3: Intended jurisdiction for service definition (if applicable) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.jurisdiction #xD; extension:topic 0..* CodeableConcept STU3: E.g. Education, Treatment, Assessment, etc (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.topic Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering #xD; extension:contributor 0..* Contributor STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.contributor #xD; extension:contact 0..* ContactDetail STU3: Contact details for the publisher (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.contact #xD; extension:copyright 0..1 markdown STU3: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.copyright #xD; extension:relatedArtifact 0..* RelatedArtifact STU3: Additional documentation, citations, etc (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.relatedArtifact #xD; extension:trigger 0..* TriggerDefinition STU3: "when" the module should be invoked (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.trigger #xD; extension:dataRequirement 0..* DataRequirement STU3: What data is used by the module (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.dataRequirement #xD; extension:operationDefinition 0..1 Reference(Cross-version Profile for STU3.OperationDefinition for use in FHIR R4B(0.1.0) | OperationDefinition) STU3: Operation to invoke (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.operationDefinition #xD; Slices for modifierExtension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; modifierExtension:status 1..1 code STU3: draft | active | retired | unknown (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.status Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map. #xD; modifierExtension:experimental 0..1 boolean STU3: For testing purposes, not real usage (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ServiceDefinition.experimental #xD; Documentation for this format
Cross-version Profile for STU3.ServiceDefinition for use in FHIR R4B
This cross-version profile allows STU3 ServiceDefinition content to be represented via FHIR R4B Basic resources.
Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
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
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $contained in f:contained return $contained[not(exists(parent::*/descendant::f:reference/@value=concat('#', $contained/*/f:id/@value)) or exists(descendant::f:reference[@value='#']))]))
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can 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.
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 information is added later.
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.
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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
not(f:Citation|f:Evidence|f:EvidenceReport|f:EvidenceVariable|f:MedicinalProductDefinition|f:PackagedProductDefinition|f:AdministrableProductDefinition|f:Ingredient|f:ClinicalUseDefinition|f:RegulatedAuthorization|f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic) or not(parent::f:Citation|parent::f:Evidence|parent::f:EvidenceReport|parent::f:EvidenceVariable|parent::f:MedicinalProductDefinition|parent::f:PackagedProductDefinition|parent::f:AdministrableProductDefinition|parent::f:Ingredient|parent::f:ClinicalUseDefinition|parent::f:RegulatedAuthorization|parent::f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic)
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
STU3: Logical URI to reference this service definition (globally unique) (new)
Element `ServiceDefinition.url` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.url` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
STU3: Business version of the service definition (new)
STU3: `ServiceDefinition.version` (new:string)
Element `ServiceDefinition.version` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.version` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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 refrence to a particular business version of the service definition with the format [url]|[version].
STU3: Name for this service definition (computer friendly) (new)
STU3: `ServiceDefinition.name` (new:string)
Element `ServiceDefinition.name` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.name` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
STU3: Name for this service definition (human friendly) (new)
STU3: `ServiceDefinition.title` (new:string)
Element `ServiceDefinition.title` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.title` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
STU3: `ServiceDefinition.date` (new:dateTime)
Element `ServiceDefinition.date` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.date` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
STU3: Name of the publisher (organization or individual) (new)
STU3: `ServiceDefinition.publisher` (new:string)
Element `ServiceDefinition.publisher` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.publisher` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
STU3: Natural language description of the service definition (new)
STU3: `ServiceDefinition.description` (new:markdown)
Element `ServiceDefinition.description` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.description` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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).
STU3: Why this service definition is defined (new)
STU3: `ServiceDefinition.purpose` (new:markdown)
Element `ServiceDefinition.purpose` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.purpose` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
STU3: Describes the clinical usage of the module (new)
STU3: `ServiceDefinition.usage` (new:string)
Element `ServiceDefinition.usage` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.usage` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
STU3: When the service definition was approved by publisher (new)
STU3: `ServiceDefinition.approvalDate` (new:date)
Element `ServiceDefinition.approvalDate` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.approvalDate` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.
STU3: When the service definition was last reviewed (new)
STU3: `ServiceDefinition.lastReviewDate` (new:date)
Element `ServiceDefinition.lastReviewDate` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.lastReviewDate` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). If specified, this is usually after the approval date.
STU3: When the service definition is expected to be used (new)
STU3: `ServiceDefinition.effectivePeriod` (new:Period)
Element `ServiceDefinition.effectivePeriod` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.effectivePeriod` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
STU3: Context the content is intended to support (new)
STU3: `ServiceDefinition.useContext` (new:UsageContext)
Element `ServiceDefinition.useContext` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.useContext` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.
STU3: Intended jurisdiction for service definition (if applicable) (new)
STU3: `ServiceDefinition.jurisdiction` (new:CodeableConcept)
Element `ServiceDefinition.jurisdiction` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.jurisdiction` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). It may be possible for the service definition to be used in jurisdictions other than those for which it was originally designed or intended.
STU3: E.g. Education, Treatment, Assessment, etc (new)
STU3: `ServiceDefinition.topic` (new:CodeableConcept)
Element `ServiceDefinition.topic` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.topic` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
STU3: `ServiceDefinition.contributor` (new:Contributor)
Element `ServiceDefinition.contributor` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.contributor` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
STU3: Contact details for the publisher (new)
STU3: `ServiceDefinition.contact` (new:ContactDetail)
Element `ServiceDefinition.contact` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.contact` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). May be a web site, an email address, a telephone number, etc.
STU3: Use and/or publishing restrictions (new)
STU3: `ServiceDefinition.copyright` (new:markdown)
Element `ServiceDefinition.copyright` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.copyright` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
STU3: Additional documentation, citations, etc (new)
STU3: `ServiceDefinition.relatedArtifact` (new:RelatedArtifact)
Element `ServiceDefinition.relatedArtifact` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.relatedArtifact` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Each related resource is either an attachment, or a reference to another resource, but not both.
STU3: "when" the module should be invoked (new)
STU3: `ServiceDefinition.trigger` (new:TriggerDefinition)
Element `ServiceDefinition.trigger` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.trigger` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
STU3: What data is used by the module (new)
STU3: `ServiceDefinition.dataRequirement` (new:DataRequirement)
Element `ServiceDefinition.dataRequirement` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.dataRequirement` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
STU3: `ServiceDefinition.operationDefinition` (new:Reference(OperationDefinition))
Element `ServiceDefinition.operationDefinition` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.operationDefinition` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
STU3: draft | active | retired | unknown (new)
STU3: `ServiceDefinition.status` (new:code)
Element `ServiceDefinition.status` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.status` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). Allows filtering of service definitions that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use a retired service definition without due consideration.
This extension is a modifier because the source element `ServiceDefinition.status` is flagged as a modifier element.
STU3: For testing purposes, not real usage (new)
STU3: `ServiceDefinition.experimental` (new:boolean)
Element `ServiceDefinition.experimental` is not mapped to FHIR R4B, since FHIR STU3 `ServiceDefinition` is not mapped. Element `ServiceDefinition.experimental` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). 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.
This extension is a modifier because the source element `ServiceDefinition.experimental` is flagged as a modifier element.
Identifier assigned to the resource for business purposes, outside the context of FHIR.
Identifies the 'type' of resource - equivalent to the resource name for other resources.
Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.
Must be able to distinguish different types of Basic resources.
This element determines what kind of resource is being represented which drives the meaning of all of the other elements.
HL7-maintained set of codes for "Basic" resources
Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.
Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.
Needed for partitioning the resource by Patient.
./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)
Identifies when the resource was first created.
Allows ordering resource instances by time.
./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)
Indicates who was responsible for creating the resource instance.
./participation[typeCode='SUB'] (possibly through a ControlAct and Role)