FHIR Clincal Guidelines (v0.1.0) (STU1 Ballot)

This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: cpg-activitydefinition

Examples:

Example id Format
RiskAssessment request activity opioidcds-riskassessment-request XML JSON

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-activitydefinition

Profile of ActivityDefinition for use with CPG Implementation Guide

This profile builds on Shareable ActivityDefinition.

This profile was published on Wed Jun 06 00:00:00 EDT 2018 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 33 elements

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition I1..1The definition of a specific activity to be taken, independent of any particular patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqf-strengthOfRecommendation SI0..1CodeableConceptThe strength of the recommendation
URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation
Binding: StrengthOfRecommendationRating (example)
... cpg-directionOfRecommendation SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation
... cqf-qualityOfEvidence SI0..1CodeableConceptThe quality of the evidence
URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence
Binding: QualityOfEvidenceRating (example)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the activity definition
... version SΣ1..1stringBusiness version of the activity definition
... name SΣI1..1stringName for this activity definition (computer friendly)
... title Σ1..1stringName for this activity definition (human friendly)
... subtitle 0..1stringSubordinate title of the activity definition
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental SΣ1..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the activity definition is intended for
Binding: SubjectType (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(http://hl7.org/fhir/R4/group.html)
... date Σ1..1dateTimeDate last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the activity definition
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose S0..1markdownWhy this activity definition is defined
... usage S0..1stringDescribes the clinical usage of the activity definition
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the activity definition was approved by publisher
... lastReviewDate S0..1dateWhen the activity definition was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the activity definition is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required)
.... label Σ0..1stringShort label
.... display SΣ1..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... url SΣ1..1urlWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource Σ0..1canonical(Resource)What resource is being referenced
... library S0..1canonical(Library)Logic used by the activity definition
... kind SΣ1..1codeKind of resource
Binding: RequestResourceType (required)
... profile 0..1canonical(StructureDefinition)What profile the resource needs to conform to
... code SΣ0..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example)
... intent 0..1codeproposal | plan | order
Binding: RequestIntent (required)
... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if the activity should not be performed
... timing[x] S0..1When activity is to occur
.... timingTimingTiming
.... timingDateTimedateTime
.... timingAgeAge
.... timingPeriodPeriod
.... timingRangeRange
.... timingDurationDuration
... location S0..1Reference(Location)Where it should happen
... participant SI0..*BackboneElementWho should participate in the action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required)
.... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example)
... product[x] 0..1What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example)
.... productReferenceReference(http://hl7.org/fhir/R4/medication.html | http://hl7.org/fhir/R4/substance.html)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosage 0..*DosageDetailed dosage instructions
... bodySite 0..*CodeableConceptWhat part of body to perform on
Binding: SNOMEDCTBodyStructures (example)
... specimenRequirement 0..*Reference(SpecimenDefinition)What specimens are required to perform this action
... observationRequirement 0..*Reference(ObservationDefinition)What observations are required to perform this action
... observationResultRequirement 0..*Reference(ObservationDefinition)What observations must be produced by this action
... transform 0..1canonical(StructureMap)Transform to apply the template
... dynamicValue SI0..*BackboneElementDynamic aspects of the definition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path S1..1stringThe path to the element to be set dynamically
.... expression S1..1ExpressionAn expression that provides the dynamic value for the customization

doco Documentation for this format

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 33 elements

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition I1..1The definition of a specific activity to be taken, independent of any particular patient or context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cqf-strengthOfRecommendation SI0..1CodeableConceptThe strength of the recommendation
URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation
Binding: StrengthOfRecommendationRating (example)
... cpg-directionOfRecommendation SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-directionOfRecommendation
... cqf-qualityOfEvidence SI0..1CodeableConceptThe quality of the evidence
URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence
Binding: QualityOfEvidenceRating (example)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this activity definition, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the activity definition
... version SΣ1..1stringBusiness version of the activity definition
... name SΣI1..1stringName for this activity definition (computer friendly)
... title Σ1..1stringName for this activity definition (human friendly)
... subtitle 0..1stringSubordinate title of the activity definition
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental SΣ1..1booleanFor testing purposes, not real usage
... subject[x] 0..1Type of individual the activity definition is intended for
Binding: SubjectType (extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(http://hl7.org/fhir/R4/group.html)
... date Σ1..1dateTimeDate last changed
... publisher SΣ1..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the activity definition
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose S0..1markdownWhy this activity definition is defined
... usage S0..1stringDescribes the clinical usage of the activity definition
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the activity definition was approved by publisher
... lastReviewDate S0..1dateWhen the activity definition was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the activity definition is expected to be used
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example)
... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required)
.... label Σ0..1stringShort label
.... display SΣ1..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... url SΣ1..1urlWhere the artifact can be accessed
.... document Σ0..1AttachmentWhat document is being referenced
.... resource Σ0..1canonical(Resource)What resource is being referenced
... library S0..1canonical(Library)Logic used by the activity definition
... kind SΣ1..1codeKind of resource
Binding: RequestResourceType (required)
... profile 0..1canonical(StructureDefinition)What profile the resource needs to conform to
... code SΣ0..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example)
... intent 0..1codeproposal | plan | order
Binding: RequestIntent (required)
... priority 0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ0..1booleanTrue if the activity should not be performed
... timing[x] S0..1When activity is to occur
.... timingTimingTiming
.... timingDateTimedateTime
.... timingAgeAge
.... timingPeriodPeriod
.... timingRangeRange
.... timingDurationDuration
... location S0..1Reference(Location)Where it should happen
... participant SI0..*BackboneElementWho should participate in the action
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1codepatient | practitioner | related-person | device
Binding: ActionParticipantType (required)
.... role 0..1CodeableConceptE.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example)
... product[x] 0..1What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example)
.... productReferenceReference(http://hl7.org/fhir/R4/medication.html | http://hl7.org/fhir/R4/substance.html)
.... productCodeableConceptCodeableConcept
... quantity 0..1SimpleQuantityHow much is administered/consumed/supplied
... dosage 0..*DosageDetailed dosage instructions
... bodySite 0..*CodeableConceptWhat part of body to perform on
Binding: SNOMEDCTBodyStructures (example)
... specimenRequirement 0..*Reference(SpecimenDefinition)What specimens are required to perform this action
... observationRequirement 0..*Reference(ObservationDefinition)What observations are required to perform this action
... observationResultRequirement 0..*Reference(ObservationDefinition)What observations must be produced by this action
... transform 0..1canonical(StructureMap)Transform to apply the template
... dynamicValue SI0..*BackboneElementDynamic aspects of the definition
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path S1..1stringThe path to the element to be set dynamically
.... expression S1..1ExpressionAn expression that provides the dynamic value for the customization

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
ActivityDefinition.languagepreferredCommonLanguages
Max Binding: AllLanguages
ActivityDefinition.statusrequiredPublicationStatus
ActivityDefinition.subject[x]extensibleSubjectType
ActivityDefinition.jurisdictionextensibleJurisdiction ValueSet
ActivityDefinition.topicexampleDefinitionTopic
ActivityDefinition.relatedArtifact.typerequiredRelatedArtifactType
ActivityDefinition.kindrequiredRequestResourceType
ActivityDefinition.codeexampleProcedureCodes(SNOMEDCT)
ActivityDefinition.intentrequiredRequestIntent
ActivityDefinition.priorityrequiredRequestPriority
ActivityDefinition.participant.typerequiredActionParticipantType
ActivityDefinition.participant.roleexampleActionParticipantRole
ActivityDefinition.product[x]exampleSNOMEDCTMedicationCodes
ActivityDefinition.bodySiteexampleSNOMEDCTBodyStructures

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4ActivityDefinitionIf 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()
dom-3ActivityDefinitionIf 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6ActivityDefinitionA resource should have narrative for robust management
: text.div.exists()
dom-5ActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
adf-0ActivityDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ele-1ActivityDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ActivityDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ActivityDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ActivityDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ActivityDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ActivityDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ActivityDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ActivityDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ActivityDefinition.participantAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ActivityDefinition.dynamicValueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())