Clinical Practice Guidelines
2.0.0 - STU2
Clinical Practice Guidelines
2.0.0 - STU2
Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0 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
| Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communicationactivity | Version: 2.0.0 | |||
| Active as of 2024-11-26 | Computable Name: CPGCommunicationActivity | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.42.39 | ||||
Definition of a recommendation for a specific communication with the patient or other participant as part of a computable clinical practice guideline
This is an activity definition profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CPGComputableActivityDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ActivityDefinition |
0..* | CPGComputableActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | |
  kind |
1..1 | code | Kind of resource Fixed Value: CommunicationRequest | |
| profile |
1..1 | canonical(StructureDefinition) | At least a CPG CommunicationRequest Fixed Value: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communicationrequest | |
 code |
0..1 | CodeableConcept | Detail type of activity Required Pattern: At least the following | |
   coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: send-message | |
| intent |
S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: proposal |
| doNotPerform |
1..1 | boolean | True if the activity should not be performed | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ActivityDefinition |
C | 0..* | CPGComputableActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
 subject[x] |
S | 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.). | |
 subjectCodeableConcept |
CodeableConcept | |||
 subjectReference |
Reference(Group) | |||
| library |
S | 0..1 | canonical(Library) | Logic used by the activity definition |
| kind |
SΣ | 1..1 | code | Kind of resource Binding: RequestResourceType (required): The kind of activity the definition is describing. Fixed Value: CommunicationRequest |
| profile |
S | 1..1 | canonical(StructureDefinition) | At least a CPG CommunicationRequest Fixed Value: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communicationrequest |
| code |
SΣ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: send-message | |
| intent |
S | 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 |
| priority |
S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| doNotPerform |
?!SΣ | 1..1 | boolean | True if the activity should not be performed |
| timing[x] |
S | 0..1 | When activity is to occur | |
| timingTiming |
Timing | |||
| timingDateTime |
dateTime | |||
| timingAge |
Age | |||
| timingPeriod |
Period | |||
| timingRange |
Range | |||
| timingDuration |
Duration | |||
| location |
S | 0..1 | Reference(Location) | Where it should happen |
| participant |
S | 0..* | BackboneElement | Who should participate in the action |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant in the activity. | |
| dynamicValue |
S | 0..* | BackboneElement | Dynamic aspects of the definition |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| path |
S | 1..1 | string | The path to the element to be set dynamically |
| expression |
S | 1..1 | Expression | An expression that provides the dynamic value for the customization |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ActivityDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| ActivityDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | |
| ActivityDefinition.kind | required | Fixed Value: CommunicationRequesthttp://hl7.org/fhir/ValueSet/request-resource-types|4.0.1from the FHIR Standard | |
| ActivityDefinition.code | example | Pattern: send-messagehttp://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| ActivityDefinition.intent | required | Fixed Value: proposalhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ActivityDefinition.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ActivityDefinition.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ActivityDefinition |
C | 0..* | CPGComputableActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the activity definition | ||||
| version |
Σ | 0..1 | string | Business version of the activity definition | ||||
| name |
ΣC | 0..1 | string | Name for this activity definition (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this activity definition (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the activity definition | |||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subject[x] |
S | 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.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the activity definition | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this activity definition is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the activity definition | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the activity definition was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the activity definition was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the activity definition is expected to be used | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
| library |
S | 0..1 | canonical(Library) | Logic used by the activity definition | ||||
| kind |
SΣ | 1..1 | code | Kind of resource Binding: RequestResourceType (required): The kind of activity the definition is describing. Fixed Value: CommunicationRequest | ||||
| profile |
S | 1..1 | canonical(StructureDefinition) | At least a CPG CommunicationRequest Fixed Value: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communicationrequest | ||||
| code |
SΣ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: send-message | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| intent |
S | 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 | ||||
| priority |
S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!SΣ | 1..1 | boolean | True if the activity should not be performed | ||||
| timing[x] |
S | 0..1 | When activity is to occur | |||||
| timingTiming |
Timing | |||||||
| timingDateTime |
dateTime | |||||||
| timingAge |
Age | |||||||
| timingPeriod |
Period | |||||||
| timingRange |
Range | |||||||
| timingDuration |
Duration | |||||||
| location |
S | 0..1 | Reference(Location) | Where it should happen | ||||
| participant |
S | 0..* | BackboneElement | Who should participate in the action | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant in the activity. | |||||
| role |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
| product[x] |
0..1 | What's administered/supplied Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication. | ||||||
| productReference |
Reference(Medication | Substance) | |||||||
| productCodeableConcept |
CodeableConcept | |||||||
| quantity |
0..1 | SimpleQuantity | How much is administered/consumed/supplied | |||||
| dosage |
0..* | Dosage | Detailed dosage instructions | |||||
| bodySite |
0..* | CodeableConcept | What part of body to perform on Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location. | |||||
| 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..1 | canonical(StructureMap) | Transform to apply the template | |||||
| dynamicValue |
S | 0..* | BackboneElement | Dynamic aspects of the definition | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| path |
S | 1..1 | string | The path to the element to be set dynamically | ||||
| expression |
S | 1..1 | Expression | An expression that provides the dynamic value for the customization | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ActivityDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ActivityDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| ActivityDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| ActivityDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| ActivityDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard | ||||
| ActivityDefinition.kind | required | Fixed Value: CommunicationRequesthttp://hl7.org/fhir/ValueSet/request-resource-types|4.0.1from the FHIR Standard | ||||
| ActivityDefinition.code | example | Pattern: send-messagehttp://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| ActivityDefinition.intent | required | Fixed Value: proposalhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ActivityDefinition.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ActivityDefinition.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1from the FHIR Standard | ||||
| ActivityDefinition.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-rolefrom the FHIR Standard | ||||
| ActivityDefinition.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| ActivityDefinition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Differential View
This structure is derived from CPGComputableActivityDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ActivityDefinition |
0..* | CPGComputableActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | |
| kind |
1..1 | code | Kind of resource Fixed Value: CommunicationRequest | |
| profile |
1..1 | canonical(StructureDefinition) | At least a CPG CommunicationRequest Fixed Value: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communicationrequest | |
| code |
0..1 | CodeableConcept | Detail type of activity Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: send-message | |
| intent |
S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: proposal |
| doNotPerform |
1..1 | boolean | True if the activity should not be performed | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ActivityDefinition |
C | 0..* | CPGComputableActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| subject[x] |
S | 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.). | |
| subjectCodeableConcept |
CodeableConcept | |||
| subjectReference |
Reference(Group) | |||
| library |
S | 0..1 | canonical(Library) | Logic used by the activity definition |
| kind |
SΣ | 1..1 | code | Kind of resource Binding: RequestResourceType (required): The kind of activity the definition is describing. Fixed Value: CommunicationRequest |
| profile |
S | 1..1 | canonical(StructureDefinition) | At least a CPG CommunicationRequest Fixed Value: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communicationrequest |
| code |
SΣ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: send-message | |
| intent |
S | 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 |
| priority |
S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| doNotPerform |
?!SΣ | 1..1 | boolean | True if the activity should not be performed |
| timing[x] |
S | 0..1 | When activity is to occur | |
| timingTiming |
Timing | |||
| timingDateTime |
dateTime | |||
| timingAge |
Age | |||
| timingPeriod |
Period | |||
| timingRange |
Range | |||
| timingDuration |
Duration | |||
| location |
S | 0..1 | Reference(Location) | Where it should happen |
| participant |
S | 0..* | BackboneElement | Who should participate in the action |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant in the activity. | |
| dynamicValue |
S | 0..* | BackboneElement | Dynamic aspects of the definition |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| path |
S | 1..1 | string | The path to the element to be set dynamically |
| expression |
S | 1..1 | Expression | An expression that provides the dynamic value for the customization |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ActivityDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| ActivityDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | |
| ActivityDefinition.kind | required | Fixed Value: CommunicationRequesthttp://hl7.org/fhir/ValueSet/request-resource-types|4.0.1from the FHIR Standard | |
| ActivityDefinition.code | example | Pattern: send-messagehttp://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| ActivityDefinition.intent | required | Fixed Value: proposalhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ActivityDefinition.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ActivityDefinition.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ActivityDefinition |
C | 0..* | CPGComputableActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the activity definition | ||||
| version |
Σ | 0..1 | string | Business version of the activity definition | ||||
| name |
ΣC | 0..1 | string | Name for this activity definition (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this activity definition (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the activity definition | |||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subject[x] |
S | 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.). | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the activity definition | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this activity definition is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the activity definition | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the activity definition was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the activity definition was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the activity definition is expected to be used | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
| library |
S | 0..1 | canonical(Library) | Logic used by the activity definition | ||||
| kind |
SΣ | 1..1 | code | Kind of resource Binding: RequestResourceType (required): The kind of activity the definition is describing. Fixed Value: CommunicationRequest | ||||
| profile |
S | 1..1 | canonical(StructureDefinition) | At least a CPG CommunicationRequest Fixed Value: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-communicationrequest | ||||
| code |
SΣ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/cpg/CodeSystem/cpg-activity-type-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: send-message | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| intent |
S | 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 | ||||
| priority |
S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!SΣ | 1..1 | boolean | True if the activity should not be performed | ||||
| timing[x] |
S | 0..1 | When activity is to occur | |||||
| timingTiming |
Timing | |||||||
| timingDateTime |
dateTime | |||||||
| timingAge |
Age | |||||||
| timingPeriod |
Period | |||||||
| timingRange |
Range | |||||||
| timingDuration |
Duration | |||||||
| location |
S | 0..1 | Reference(Location) | Where it should happen | ||||
| participant |
S | 0..* | BackboneElement | Who should participate in the action | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant in the activity. | |||||
| role |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. Binding: ActionParticipantRole (example): Defines roles played by participants for the action. | |||||
| product[x] |
0..1 | What's administered/supplied Binding: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication. | ||||||
| productReference |
Reference(Medication | Substance) | |||||||
| productCodeableConcept |
CodeableConcept | |||||||
| quantity |
0..1 | SimpleQuantity | How much is administered/consumed/supplied | |||||
| dosage |
0..* | Dosage | Detailed dosage instructions | |||||
| bodySite |
0..* | CodeableConcept | What part of body to perform on Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location. | |||||
| 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..1 | canonical(StructureMap) | Transform to apply the template | |||||
| dynamicValue |
S | 0..* | BackboneElement | Dynamic aspects of the definition | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| path |
S | 1..1 | string | The path to the element to be set dynamically | ||||
| expression |
S | 1..1 | Expression | An expression that provides the dynamic value for the customization | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ActivityDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ActivityDefinition.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| ActivityDefinition.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| ActivityDefinition.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| ActivityDefinition.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard | ||||
| ActivityDefinition.kind | required | Fixed Value: CommunicationRequesthttp://hl7.org/fhir/ValueSet/request-resource-types|4.0.1from the FHIR Standard | ||||
| ActivityDefinition.code | example | Pattern: send-messagehttp://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| ActivityDefinition.intent | required | Fixed Value: proposalhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ActivityDefinition.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ActivityDefinition.participant.type | required | ActionParticipantTypehttp://hl7.org/fhir/ValueSet/action-participant-type|4.0.1from the FHIR Standard | ||||
| ActivityDefinition.participant.role | example | ActionParticipantRolehttp://hl7.org/fhir/ValueSet/action-participant-rolefrom the FHIR Standard | ||||
| ActivityDefinition.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| ActivityDefinition.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.cpg#2.0.0 based on FHIR 4.0.1. Generated 2024-11-26
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change