Clinical Practice Guidelines
3.0.0-ballot - STU 3 Ballot International flag

Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

Resource Profile: CPG Propose Diagnosis Activity

Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-proposediagnosisactivity Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 4 * Computable Name: CPGProposeDiagnosisActivity
Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.42.100

The definition of a recommendation to propose a specific diagnosis as part of a computable clinical practice guideline

Use this ActivityDefinition profile to propose a diagnosis for review in reusable guideline content. It specifies the request type and profile to construct for a patient, together with the proposed activity’s intent. A recommendation definition can reference it; the patient-specific request and any documented clinical event are separate resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 0..* CPGComputableActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
ActivityDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ActivityDefinition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
ActivityDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ActivityDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ActivityDefinition.subject[x] This element must be supported. 0..1 Type of individual the activity definition is intended for
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
ActivityDefinition.subject[x].subjectCodeableConcept CodeableConcept
ActivityDefinition.subject[x].subjectReference Reference(Group)
ActivityDefinition.library This element must be supported. 0..1 canonical(Library) Logic used by the activity definition
ActivityDefinition.kind This element must be supported. This element is included in summaries. 1..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.
Fixed Value: Task (no extensions allowed)
ActivityDefinition.profile This element must be supported. 1..1 canonical(StructureDefinition) At least a CPG Propose Diagnosis Task
Fixed Value: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-proposediagnosistask (no extensions allowed)
ActivityDefinition.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs",
      "code" : "propose-diagnosis"
    }
  ]
}
ActivityDefinition.intent This element must be supported. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
Fixed Value: proposal (no extensions allowed)
ActivityDefinition.priority This element must be supported. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ActivityDefinition.doNotPerform This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean True if the activity should not be performed
ActivityDefinition.timing[x] This element must be supported. 0..1 When activity is to occur
ActivityDefinition.timing[x].timingTiming Timing
ActivityDefinition.timing[x].timingDateTime dateTime
ActivityDefinition.timing[x].timingAge Age
ActivityDefinition.timing[x].timingPeriod Period
ActivityDefinition.timing[x].timingRange Range
ActivityDefinition.timing[x].timingDuration Duration
ActivityDefinition.location This element must be supported. 0..1 Reference(Location) Where it should happen
ActivityDefinition.participant This element must be supported. 0..* BackboneElement Who should participate in the action
ActivityDefinition.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ActivityDefinition.participant.type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant in the activity.
ActivityDefinition.dynamicValue This element must be supported. 0..* BackboneElement Dynamic aspects of the definition
ActivityDefinition.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ActivityDefinition.dynamicValue.path This element must be supported. 1..1 string The path to the element to be set dynamically
ActivityDefinition.dynamicValue.expression This element must be supported. 1..1 Expression An expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.

The lifecycle status of an artifact.

ActivityDefinition.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.

The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

ActivityDefinition.kind Base required RequestResourceType 📍4.0.1 FHIR Std.

The kind of activity the definition is describing.

ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.

Detailed type of the activity; e.g. CBC.

ActivityDefinition.intent Base required RequestIntent 📍4.0.1 FHIR Std.

Codes indicating the degree of authority/intentionality associated with a request.

ActivityDefinition.priority Base required Request priority 📍4.0.1 FHIR Std.

Identifies the level of importance to be assigned to actioning the request.

ActivityDefinition.participant.​type Base required ActionParticipantType 📍4.0.1 FHIR Std.

The type of participant in the activity.

Constraints

Id Grade Path(s) Description Expression
adf-0 warning ActivityDefinition Name 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}')
dom-2 error ActivityDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ActivityDefinition 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 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-4 error ActivityDefinition 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()
dom-5 error ActivityDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ActivityDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CPGComputableActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition 0..* CPGComputableActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
ActivityDefinition.kind 1..1 code Kind of resource
Fixed Value: Task (no extensions allowed)
ActivityDefinition.profile 1..1 canonical(StructureDefinition) At least a CPG Propose Diagnosis Task
Fixed Value: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-proposediagnosistask (no extensions allowed)
ActivityDefinition.code 0..1 CodeableConcept Detail type of activity
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs",
      "code" : "propose-diagnosis"
    }
  ]
}
ActivityDefinition.doNotPerform 1..1 boolean True if the activity should not be performed

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 0..* CPGComputableActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
ActivityDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
ActivityDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ActivityDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ActivityDefinition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ActivityDefinition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
ActivityDefinition.contained 0..* Resource Contained, inline Resources
ActivityDefinition.extension 0..* Extension Additional content defined by implementations
ActivityDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ActivityDefinition.url This element is included in summaries. 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
ActivityDefinition.identifier This element is included in summaries. 0..* Identifier Additional identifier for the activity definition
ActivityDefinition.version This element is included in summaries. 0..1 string Business version of the activity definition
ActivityDefinition.name This element is included in summaries. C 0..1 string Name for this activity definition (computer friendly)
ActivityDefinition.title This element is included in summaries. 0..1 string Name for this activity definition (human friendly)
ActivityDefinition.subtitle 0..1 string Subordinate title of the activity definition
ActivityDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ActivityDefinition.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
ActivityDefinition.subject[x] This element must be supported. 0..1 Type of individual the activity definition is intended for
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
ActivityDefinition.subject[x].subjectCodeableConcept CodeableConcept
ActivityDefinition.subject[x].subjectReference Reference(Group)
ActivityDefinition.date This element is included in summaries. 0..1 dateTime Date last changed
ActivityDefinition.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
ActivityDefinition.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ActivityDefinition.description This element is included in summaries. 0..1 markdown Natural language description of the activity definition
ActivityDefinition.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ActivityDefinition.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ActivityDefinition.purpose 0..1 markdown Why this activity definition is defined
ActivityDefinition.usage 0..1 string Describes the clinical usage of the activity definition
ActivityDefinition.copyright 0..1 markdown Use and/or publishing restrictions
ActivityDefinition.approvalDate 0..1 date When the activity definition was approved by publisher
ActivityDefinition.lastReviewDate 0..1 date When the activity definition was last reviewed
ActivityDefinition.effectivePeriod This element is included in summaries. 0..1 Period When the activity definition is expected to be used
ActivityDefinition.topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
ActivityDefinition.author 0..* ContactDetail Who authored the content
ActivityDefinition.editor 0..* ContactDetail Who edited the content
ActivityDefinition.reviewer 0..* ContactDetail Who reviewed the content
ActivityDefinition.endorser 0..* ContactDetail Who endorsed the content
ActivityDefinition.relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
ActivityDefinition.library This element must be supported. 0..1 canonical(Library) Logic used by the activity definition
ActivityDefinition.kind This element must be supported. This element is included in summaries. 1..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.
Fixed Value: Task (no extensions allowed)
ActivityDefinition.profile This element must be supported. 1..1 canonical(StructureDefinition) At least a CPG Propose Diagnosis Task
Fixed Value: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-proposediagnosistask (no extensions allowed)
ActivityDefinition.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs",
      "code" : "propose-diagnosis"
    }
  ]
}
ActivityDefinition.intent This element must be supported. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
Fixed Value: proposal (no extensions allowed)
ActivityDefinition.priority This element must be supported. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ActivityDefinition.doNotPerform This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean True if the activity should not be performed
ActivityDefinition.timing[x] This element must be supported. 0..1 When activity is to occur
ActivityDefinition.timing[x].timingTiming Timing
ActivityDefinition.timing[x].timingDateTime dateTime
ActivityDefinition.timing[x].timingAge Age
ActivityDefinition.timing[x].timingPeriod Period
ActivityDefinition.timing[x].timingRange Range
ActivityDefinition.timing[x].timingDuration Duration
ActivityDefinition.location This element must be supported. 0..1 Reference(Location) Where it should happen
ActivityDefinition.participant This element must be supported. 0..* BackboneElement Who should participate in the action
ActivityDefinition.participant.id 0..1 string Unique id for inter-element referencing
ActivityDefinition.participant.extension 0..* Extension Additional content defined by implementations
ActivityDefinition.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ActivityDefinition.participant.type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant in the activity.
ActivityDefinition.participant.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
ActivityDefinition.product[x] 0..1 What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.
ActivityDefinition.product[x].productReference Reference(Medication | Substance)
ActivityDefinition.product[x].productCodeableConcept CodeableConcept
ActivityDefinition.quantity C 0..1 SimpleQuantity(4.0.1) How much is administered/consumed/supplied
Constraints: sqty-1
ActivityDefinition.dosage 0..* Dosage Detailed dosage instructions
ActivityDefinition.bodySite 0..* CodeableConcept What part of body to perform on
Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location.
ActivityDefinition.specimenRequirement 0..* Reference(SpecimenDefinition) What specimens are required to perform this action
ActivityDefinition.observationRequirement 0..* Reference(ObservationDefinition) What observations are required to perform this action
ActivityDefinition.observationResultRequirement 0..* Reference(ObservationDefinition) What observations must be produced by this action
ActivityDefinition.transform 0..1 canonical(StructureMap) Transform to apply the template
ActivityDefinition.dynamicValue This element must be supported. 0..* BackboneElement Dynamic aspects of the definition
ActivityDefinition.dynamicValue.id 0..1 string Unique id for inter-element referencing
ActivityDefinition.dynamicValue.extension 0..* Extension Additional content defined by implementations
ActivityDefinition.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ActivityDefinition.dynamicValue.path This element must be supported. 1..1 string The path to the element to be set dynamically
ActivityDefinition.dynamicValue.expression This element must be supported. 1..1 Expression An expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
ActivityDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.

A human language.

ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.

The lifecycle status of an artifact.

ActivityDefinition.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.

The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

ActivityDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.

Countries and regions within which this artifact is targeted for use.

ActivityDefinition.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.

High-level categorization of the definition, used for searching, sorting, and filtering.

ActivityDefinition.kind Base required RequestResourceType 📍4.0.1 FHIR Std.

The kind of activity the definition is describing.

ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.

Detailed type of the activity; e.g. CBC.

ActivityDefinition.intent Base required RequestIntent 📍4.0.1 FHIR Std.

Codes indicating the degree of authority/intentionality associated with a request.

ActivityDefinition.priority Base required Request priority 📍4.0.1 FHIR Std.

Identifies the level of importance to be assigned to actioning the request.

ActivityDefinition.participant.​type Base required ActionParticipantType 📍4.0.1 FHIR Std.

The type of participant in the activity.

ActivityDefinition.participant.​role Base example Action participant role 📍4.0.1 FHIR Std.

Defines roles played by participants for the action.

ActivityDefinition.product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Code describing the type of substance or medication.

ActivityDefinition.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

A code that identifies the anatomical location.

Constraints

Id Grade Path(s) Description Expression
adf-0 warning ActivityDefinition Name 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}')
dom-2 error ActivityDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ActivityDefinition 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 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-4 error ActivityDefinition 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()
dom-5 error ActivityDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ActivityDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sqty-1 error ActivityDefinition.quantity The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from CPGComputableActivityDefinition

Summary

Mandatory: 3 elements
Must-Support: 1 element
Fixed: 3 elements

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 0..* CPGComputableActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
ActivityDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ActivityDefinition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
ActivityDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ActivityDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ActivityDefinition.subject[x] This element must be supported. 0..1 Type of individual the activity definition is intended for
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
ActivityDefinition.subject[x].subjectCodeableConcept CodeableConcept
ActivityDefinition.subject[x].subjectReference Reference(Group)
ActivityDefinition.library This element must be supported. 0..1 canonical(Library) Logic used by the activity definition
ActivityDefinition.kind This element must be supported. This element is included in summaries. 1..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.
Fixed Value: Task (no extensions allowed)
ActivityDefinition.profile This element must be supported. 1..1 canonical(StructureDefinition) At least a CPG Propose Diagnosis Task
Fixed Value: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-proposediagnosistask (no extensions allowed)
ActivityDefinition.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs",
      "code" : "propose-diagnosis"
    }
  ]
}
ActivityDefinition.intent This element must be supported. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
Fixed Value: proposal (no extensions allowed)
ActivityDefinition.priority This element must be supported. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ActivityDefinition.doNotPerform This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean True if the activity should not be performed
ActivityDefinition.timing[x] This element must be supported. 0..1 When activity is to occur
ActivityDefinition.timing[x].timingTiming Timing
ActivityDefinition.timing[x].timingDateTime dateTime
ActivityDefinition.timing[x].timingAge Age
ActivityDefinition.timing[x].timingPeriod Period
ActivityDefinition.timing[x].timingRange Range
ActivityDefinition.timing[x].timingDuration Duration
ActivityDefinition.location This element must be supported. 0..1 Reference(Location) Where it should happen
ActivityDefinition.participant This element must be supported. 0..* BackboneElement Who should participate in the action
ActivityDefinition.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ActivityDefinition.participant.type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant in the activity.
ActivityDefinition.dynamicValue This element must be supported. 0..* BackboneElement Dynamic aspects of the definition
ActivityDefinition.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ActivityDefinition.dynamicValue.path This element must be supported. 1..1 string The path to the element to be set dynamically
ActivityDefinition.dynamicValue.expression This element must be supported. 1..1 Expression An expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.

The lifecycle status of an artifact.

ActivityDefinition.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.

The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

ActivityDefinition.kind Base required RequestResourceType 📍4.0.1 FHIR Std.

The kind of activity the definition is describing.

ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.

Detailed type of the activity; e.g. CBC.

ActivityDefinition.intent Base required RequestIntent 📍4.0.1 FHIR Std.

Codes indicating the degree of authority/intentionality associated with a request.

ActivityDefinition.priority Base required Request priority 📍4.0.1 FHIR Std.

Identifies the level of importance to be assigned to actioning the request.

ActivityDefinition.participant.​type Base required ActionParticipantType 📍4.0.1 FHIR Std.

The type of participant in the activity.

Constraints

Id Grade Path(s) Description Expression
adf-0 warning ActivityDefinition Name 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}')
dom-2 error ActivityDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ActivityDefinition 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 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-4 error ActivityDefinition 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()
dom-5 error ActivityDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ActivityDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from CPGComputableActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition 0..* CPGComputableActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
ActivityDefinition.kind 1..1 code Kind of resource
Fixed Value: Task (no extensions allowed)
ActivityDefinition.profile 1..1 canonical(StructureDefinition) At least a CPG Propose Diagnosis Task
Fixed Value: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-proposediagnosistask (no extensions allowed)
ActivityDefinition.code 0..1 CodeableConcept Detail type of activity
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs",
      "code" : "propose-diagnosis"
    }
  ]
}
ActivityDefinition.intent This element must be supported. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Fixed Value: proposal (no extensions allowed)
ActivityDefinition.doNotPerform 1..1 boolean True if the activity should not be performed

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 0..* CPGComputableActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0
ActivityDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
ActivityDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ActivityDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ActivityDefinition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ActivityDefinition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
ActivityDefinition.contained 0..* Resource Contained, inline Resources
ActivityDefinition.extension 0..* Extension Additional content defined by implementations
ActivityDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ActivityDefinition.url This element is included in summaries. 0..1 uri Canonical identifier for this activity definition, represented as a URI (globally unique)
ActivityDefinition.identifier This element is included in summaries. 0..* Identifier Additional identifier for the activity definition
ActivityDefinition.version This element is included in summaries. 0..1 string Business version of the activity definition
ActivityDefinition.name This element is included in summaries. C 0..1 string Name for this activity definition (computer friendly)
ActivityDefinition.title This element is included in summaries. 0..1 string Name for this activity definition (human friendly)
ActivityDefinition.subtitle 0..1 string Subordinate title of the activity definition
ActivityDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ActivityDefinition.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
ActivityDefinition.subject[x] This element must be supported. 0..1 Type of individual the activity definition is intended for
Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
ActivityDefinition.subject[x].subjectCodeableConcept CodeableConcept
ActivityDefinition.subject[x].subjectReference Reference(Group)
ActivityDefinition.date This element is included in summaries. 0..1 dateTime Date last changed
ActivityDefinition.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
ActivityDefinition.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ActivityDefinition.description This element is included in summaries. 0..1 markdown Natural language description of the activity definition
ActivityDefinition.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ActivityDefinition.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ActivityDefinition.purpose 0..1 markdown Why this activity definition is defined
ActivityDefinition.usage 0..1 string Describes the clinical usage of the activity definition
ActivityDefinition.copyright 0..1 markdown Use and/or publishing restrictions
ActivityDefinition.approvalDate 0..1 date When the activity definition was approved by publisher
ActivityDefinition.lastReviewDate 0..1 date When the activity definition was last reviewed
ActivityDefinition.effectivePeriod This element is included in summaries. 0..1 Period When the activity definition is expected to be used
ActivityDefinition.topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
ActivityDefinition.author 0..* ContactDetail Who authored the content
ActivityDefinition.editor 0..* ContactDetail Who edited the content
ActivityDefinition.reviewer 0..* ContactDetail Who reviewed the content
ActivityDefinition.endorser 0..* ContactDetail Who endorsed the content
ActivityDefinition.relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
ActivityDefinition.library This element must be supported. 0..1 canonical(Library) Logic used by the activity definition
ActivityDefinition.kind This element must be supported. This element is included in summaries. 1..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.
Fixed Value: Task (no extensions allowed)
ActivityDefinition.profile This element must be supported. 1..1 canonical(StructureDefinition) At least a CPG Propose Diagnosis Task
Fixed Value: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-proposediagnosistask (no extensions allowed)
ActivityDefinition.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs",
      "code" : "propose-diagnosis"
    }
  ]
}
ActivityDefinition.intent This element must be supported. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
Fixed Value: proposal (no extensions allowed)
ActivityDefinition.priority This element must be supported. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ActivityDefinition.doNotPerform This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean True if the activity should not be performed
ActivityDefinition.timing[x] This element must be supported. 0..1 When activity is to occur
ActivityDefinition.timing[x].timingTiming Timing
ActivityDefinition.timing[x].timingDateTime dateTime
ActivityDefinition.timing[x].timingAge Age
ActivityDefinition.timing[x].timingPeriod Period
ActivityDefinition.timing[x].timingRange Range
ActivityDefinition.timing[x].timingDuration Duration
ActivityDefinition.location This element must be supported. 0..1 Reference(Location) Where it should happen
ActivityDefinition.participant This element must be supported. 0..* BackboneElement Who should participate in the action
ActivityDefinition.participant.id 0..1 string Unique id for inter-element referencing
ActivityDefinition.participant.extension 0..* Extension Additional content defined by implementations
ActivityDefinition.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ActivityDefinition.participant.type 1..1 code patient | practitioner | related-person | device
Binding: ActionParticipantType (required): The type of participant in the activity.
ActivityDefinition.participant.role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc.
Binding: ActionParticipantRole (example): Defines roles played by participants for the action.
ActivityDefinition.product[x] 0..1 What's administered/supplied
Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication.
ActivityDefinition.product[x].productReference Reference(Medication | Substance)
ActivityDefinition.product[x].productCodeableConcept CodeableConcept
ActivityDefinition.quantity C 0..1 SimpleQuantity(4.0.1) How much is administered/consumed/supplied
Constraints: sqty-1
ActivityDefinition.dosage 0..* Dosage Detailed dosage instructions
ActivityDefinition.bodySite 0..* CodeableConcept What part of body to perform on
Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location.
ActivityDefinition.specimenRequirement 0..* Reference(SpecimenDefinition) What specimens are required to perform this action
ActivityDefinition.observationRequirement 0..* Reference(ObservationDefinition) What observations are required to perform this action
ActivityDefinition.observationResultRequirement 0..* Reference(ObservationDefinition) What observations must be produced by this action
ActivityDefinition.transform 0..1 canonical(StructureMap) Transform to apply the template
ActivityDefinition.dynamicValue This element must be supported. 0..* BackboneElement Dynamic aspects of the definition
ActivityDefinition.dynamicValue.id 0..1 string Unique id for inter-element referencing
ActivityDefinition.dynamicValue.extension 0..* Extension Additional content defined by implementations
ActivityDefinition.dynamicValue.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ActivityDefinition.dynamicValue.path This element must be supported. 1..1 string The path to the element to be set dynamically
ActivityDefinition.dynamicValue.expression This element must be supported. 1..1 Expression An expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
ActivityDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.

A human language.

ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.

The lifecycle status of an artifact.

ActivityDefinition.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.

The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

ActivityDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.

Countries and regions within which this artifact is targeted for use.

ActivityDefinition.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.

High-level categorization of the definition, used for searching, sorting, and filtering.

ActivityDefinition.kind Base required RequestResourceType 📍4.0.1 FHIR Std.

The kind of activity the definition is describing.

ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.

Detailed type of the activity; e.g. CBC.

ActivityDefinition.intent Base required RequestIntent 📍4.0.1 FHIR Std.

Codes indicating the degree of authority/intentionality associated with a request.

ActivityDefinition.priority Base required Request priority 📍4.0.1 FHIR Std.

Identifies the level of importance to be assigned to actioning the request.

ActivityDefinition.participant.​type Base required ActionParticipantType 📍4.0.1 FHIR Std.

The type of participant in the activity.

ActivityDefinition.participant.​role Base example Action participant role 📍4.0.1 FHIR Std.

Defines roles played by participants for the action.

ActivityDefinition.product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Code describing the type of substance or medication.

ActivityDefinition.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

A code that identifies the anatomical location.

Constraints

Id Grade Path(s) Description Expression
adf-0 warning ActivityDefinition Name 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}')
dom-2 error ActivityDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ActivityDefinition 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 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-4 error ActivityDefinition 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()
dom-5 error ActivityDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ActivityDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sqty-1 error ActivityDefinition.quantity The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from CPGComputableActivityDefinition

Summary

Mandatory: 3 elements
Must-Support: 1 element
Fixed: 3 elements

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron

Notes:

  • kind is fixed to Task, and profile is fixed to CPGProposeDiagnosisTask. The code pattern includes propose-diagnosis when code is present.

  • intent is fixed to proposal. doNotPerform is required but has no fixed boolean value; distinguish recommending the activity from recommending that it not be performed.

  • Populate the resulting Task’s required diagnosis input with a Condition reference. Applying the definition produces a Task; it does not by itself confirm or record a diagnosis.

Related: resulting request profile; activity examples; Activity Flow.