Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, 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/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMI Publishable ActivityDefinition

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishableactivitydefinition Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: CRMIPublishableActivityDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.30

Supports declaration of the ActivityDefinition metadata required by HL7 and other organizations that share and publish activity definitions with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

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 1..1 ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0, pub-1
ActivityDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ActivityDefinition.meta.Slices for extension Content/Rules for all slices
ActivityDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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.Slices for extension Content/Rules for all slices
ActivityDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ActivityDefinition.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
ActivityDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ActivityDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ActivityDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ActivityDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ActivityDefinition.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for 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.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
ActivityDefinition.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ActivityDefinition.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ActivityDefinition.jurisdiction This element must be supported. 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 This element must be supported. 0..1 markdown Why this activity definition is defined
ActivityDefinition.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
ActivityDefinition.approvalDate This element must be supported. 0..1 date When the activity definition was approved by publisher
ActivityDefinition.lastReviewDate This element must be supported. 0..1 date When the activity definition was last reviewed
ActivityDefinition.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the activity definition is expected to be used
ActivityDefinition.topic This element must be supported. 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 This element must be supported. 0..* ContactDetail Who authored the content
ActivityDefinition.editor This element must be supported. 0..* ContactDetail Who edited the content
ActivityDefinition.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
ActivityDefinition.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
ActivityDefinition.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
ActivityDefinition.relatedArtifact.Slices for extension Content/Rules for all slices
ActivityDefinition.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ActivityDefinition.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ActivityDefinition.relatedArtifact.type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
ActivityDefinition.relatedArtifact.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
ActivityDefinition.relatedArtifact.document This element must be supported. This element is included in summaries. 0..1 Attachment What document is being referenced
ActivityDefinition.relatedArtifact.resource This element must be supported. This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
ActivityDefinition.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if the activity should not be performed

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ActivityDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ActivityDefinition.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
ActivityDefinition.relatedArtifact.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.

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()
pub-1 error ActivityDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 1..1 ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: pub-1
ActivityDefinition.meta
ActivityDefinition.meta.Slices for extension Content/Rules for all slices
ActivityDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ActivityDefinition.Slices for extension Content/Rules for all slices
ActivityDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ActivityDefinition.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
ActivityDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ActivityDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ActivityDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ActivityDefinition.identifier This element must be supported. 0..* Identifier Additional identifier for the activity definition
ActivityDefinition.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
ActivityDefinition.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
ActivityDefinition.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable)
ActivityDefinition.purpose This element must be supported. 0..1 markdown Why this activity definition is defined
ActivityDefinition.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
ActivityDefinition.approvalDate This element must be supported. 0..1 date When the activity definition was approved by publisher
ActivityDefinition.lastReviewDate This element must be supported. 0..1 date When the activity definition was last reviewed
ActivityDefinition.effectivePeriod This element must be supported. 0..1 Period When the activity definition is expected to be used
ActivityDefinition.topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
ActivityDefinition.author This element must be supported. 0..* ContactDetail Who authored the content
ActivityDefinition.editor This element must be supported. 0..* ContactDetail Who edited the content
ActivityDefinition.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
ActivityDefinition.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
ActivityDefinition.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
ActivityDefinition.relatedArtifact.Slices for extension Content/Rules for all slices
ActivityDefinition.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ActivityDefinition.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ActivityDefinition.relatedArtifact.display This element must be supported. 0..1 string Brief description of the related artifact
ActivityDefinition.relatedArtifact.document This element must be supported. 0..1 Attachment What document is being referenced
ActivityDefinition.relatedArtifact.resource This element must be supported. 0..1 canonical(Resource) What resource is being referenced

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error ActivityDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 1..1 ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0, pub-1
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.meta.id 0..1 string Unique id for inter-element referencing
ActivityDefinition.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ActivityDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ActivityDefinition.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
ActivityDefinition.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
ActivityDefinition.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
ActivityDefinition.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ActivityDefinition.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ActivityDefinition.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ActivityDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ActivityDefinition.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
ActivityDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ActivityDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ActivityDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
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 must be supported. 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] 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 must be supported. This element is included in summaries. 1..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 must be supported. 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 must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ActivityDefinition.jurisdiction This element must be supported. 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 This element must be supported. 0..1 markdown Why this activity definition is defined
ActivityDefinition.usage 0..1 string Describes the clinical usage of the activity definition
ActivityDefinition.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
ActivityDefinition.approvalDate This element must be supported. 0..1 date When the activity definition was approved by publisher
ActivityDefinition.lastReviewDate This element must be supported. 0..1 date When the activity definition was last reviewed
ActivityDefinition.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the activity definition is expected to be used
ActivityDefinition.topic This element must be supported. 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 This element must be supported. 0..* ContactDetail Who authored the content
ActivityDefinition.editor This element must be supported. 0..* ContactDetail Who edited the content
ActivityDefinition.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
ActivityDefinition.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
ActivityDefinition.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
ActivityDefinition.relatedArtifact.id 0..1 string Unique id for inter-element referencing
ActivityDefinition.relatedArtifact.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ActivityDefinition.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ActivityDefinition.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ActivityDefinition.relatedArtifact.type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
ActivityDefinition.relatedArtifact.label This element is included in summaries. 0..1 string Short label
ActivityDefinition.relatedArtifact.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
ActivityDefinition.relatedArtifact.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
ActivityDefinition.relatedArtifact.url This element is included in summaries. 0..1 url Where the artifact can be accessed
ActivityDefinition.relatedArtifact.document This element must be supported. This element is included in summaries. 0..1 Attachment What document is being referenced
ActivityDefinition.relatedArtifact.resource This element must be supported. This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
ActivityDefinition.library 0..* canonical(Library) Logic used by the activity definition
ActivityDefinition.kind This element is included in summaries. 0..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.
ActivityDefinition.profile 0..1 canonical(StructureDefinition) What profile the resource needs to conform to
ActivityDefinition.code 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.
ActivityDefinition.intent 0..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.
ActivityDefinition.priority 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 is included in summaries. 0..1 boolean True if the activity should not be performed
ActivityDefinition.timing[x] 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 0..1 Reference(Location) Where it should happen
ActivityDefinition.participant 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 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 1..1 string The path to the element to be set dynamically
ActivityDefinition.dynamicValue.expression 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
ActivityDefinition.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ActivityDefinition.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
ActivityDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ActivityDefinition.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
ActivityDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ActivityDefinition.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
ActivityDefinition.relatedArtifact.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
ActivityDefinition.kind Base required RequestResourceType 📍4.0.1 FHIR Std.
ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ActivityDefinition.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ActivityDefinition.priority Base required Request priority 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​type Base required ActionParticipantType 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​role Base example Action participant role 📍4.0.1 FHIR Std.
ActivityDefinition.product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
ActivityDefinition.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

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()
pub-1 error ActivityDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
sqty-1 error ActivityDefinition.quantity The comparator is not used on a SimpleQuantity comparator.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 1..1 ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0, pub-1
ActivityDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ActivityDefinition.meta.Slices for extension Content/Rules for all slices
ActivityDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
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.Slices for extension Content/Rules for all slices
ActivityDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ActivityDefinition.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
ActivityDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ActivityDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ActivityDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ActivityDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ActivityDefinition.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for 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.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
ActivityDefinition.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ActivityDefinition.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ActivityDefinition.jurisdiction This element must be supported. 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 This element must be supported. 0..1 markdown Why this activity definition is defined
ActivityDefinition.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
ActivityDefinition.approvalDate This element must be supported. 0..1 date When the activity definition was approved by publisher
ActivityDefinition.lastReviewDate This element must be supported. 0..1 date When the activity definition was last reviewed
ActivityDefinition.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the activity definition is expected to be used
ActivityDefinition.topic This element must be supported. 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 This element must be supported. 0..* ContactDetail Who authored the content
ActivityDefinition.editor This element must be supported. 0..* ContactDetail Who edited the content
ActivityDefinition.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
ActivityDefinition.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
ActivityDefinition.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
ActivityDefinition.relatedArtifact.Slices for extension Content/Rules for all slices
ActivityDefinition.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ActivityDefinition.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ActivityDefinition.relatedArtifact.type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
ActivityDefinition.relatedArtifact.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
ActivityDefinition.relatedArtifact.document This element must be supported. This element is included in summaries. 0..1 Attachment What document is being referenced
ActivityDefinition.relatedArtifact.resource This element must be supported. This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
ActivityDefinition.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if the activity should not be performed

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ActivityDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ActivityDefinition.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
ActivityDefinition.relatedArtifact.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.

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()
pub-1 error ActivityDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Differential View

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 1..1 ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: pub-1
ActivityDefinition.meta
ActivityDefinition.meta.Slices for extension Content/Rules for all slices
ActivityDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ActivityDefinition.Slices for extension Content/Rules for all slices
ActivityDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ActivityDefinition.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
ActivityDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ActivityDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ActivityDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ActivityDefinition.identifier This element must be supported. 0..* Identifier Additional identifier for the activity definition
ActivityDefinition.date This element must be supported. 1..1 dateTime Date last changed
ActivityDefinition.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
ActivityDefinition.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
ActivityDefinition.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable)
ActivityDefinition.purpose This element must be supported. 0..1 markdown Why this activity definition is defined
ActivityDefinition.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
ActivityDefinition.approvalDate This element must be supported. 0..1 date When the activity definition was approved by publisher
ActivityDefinition.lastReviewDate This element must be supported. 0..1 date When the activity definition was last reviewed
ActivityDefinition.effectivePeriod This element must be supported. 0..1 Period When the activity definition is expected to be used
ActivityDefinition.topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
ActivityDefinition.author This element must be supported. 0..* ContactDetail Who authored the content
ActivityDefinition.editor This element must be supported. 0..* ContactDetail Who edited the content
ActivityDefinition.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
ActivityDefinition.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
ActivityDefinition.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
ActivityDefinition.relatedArtifact.Slices for extension Content/Rules for all slices
ActivityDefinition.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ActivityDefinition.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ActivityDefinition.relatedArtifact.display This element must be supported. 0..1 string Brief description of the related artifact
ActivityDefinition.relatedArtifact.document This element must be supported. 0..1 Attachment What document is being referenced
ActivityDefinition.relatedArtifact.resource This element must be supported. 0..1 canonical(Resource) What resource is being referenced

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error ActivityDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ActivityDefinition C 1..1 ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
Constraints: adf-0, pub-1
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.meta.id 0..1 string Unique id for inter-element referencing
ActivityDefinition.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ActivityDefinition.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ActivityDefinition.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
ActivityDefinition.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
ActivityDefinition.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
ActivityDefinition.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ActivityDefinition.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ActivityDefinition.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ActivityDefinition.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ActivityDefinition.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
ActivityDefinition.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ActivityDefinition.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ActivityDefinition.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
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 must be supported. 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] 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 must be supported. This element is included in summaries. 1..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 must be supported. 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 must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ActivityDefinition.jurisdiction This element must be supported. 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 This element must be supported. 0..1 markdown Why this activity definition is defined
ActivityDefinition.usage 0..1 string Describes the clinical usage of the activity definition
ActivityDefinition.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
ActivityDefinition.approvalDate This element must be supported. 0..1 date When the activity definition was approved by publisher
ActivityDefinition.lastReviewDate This element must be supported. 0..1 date When the activity definition was last reviewed
ActivityDefinition.effectivePeriod This element must be supported. This element is included in summaries. 0..1 Period When the activity definition is expected to be used
ActivityDefinition.topic This element must be supported. 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 This element must be supported. 0..* ContactDetail Who authored the content
ActivityDefinition.editor This element must be supported. 0..* ContactDetail Who edited the content
ActivityDefinition.reviewer This element must be supported. 0..* ContactDetail Who reviewed the content
ActivityDefinition.endorser This element must be supported. 0..* ContactDetail Who endorsed the content
ActivityDefinition.relatedArtifact This element must be supported. 0..* RelatedArtifact Additional documentation, citations, etc.
ActivityDefinition.relatedArtifact.id 0..1 string Unique id for inter-element referencing
ActivityDefinition.relatedArtifact.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ActivityDefinition.relatedArtifact.Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ActivityDefinition.relatedArtifact.Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ActivityDefinition.relatedArtifact.type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
ActivityDefinition.relatedArtifact.label This element is included in summaries. 0..1 string Short label
ActivityDefinition.relatedArtifact.display This element must be supported. This element is included in summaries. 0..1 string Brief description of the related artifact
ActivityDefinition.relatedArtifact.citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
ActivityDefinition.relatedArtifact.url This element is included in summaries. 0..1 url Where the artifact can be accessed
ActivityDefinition.relatedArtifact.document This element must be supported. This element is included in summaries. 0..1 Attachment What document is being referenced
ActivityDefinition.relatedArtifact.resource This element must be supported. This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
ActivityDefinition.library 0..* canonical(Library) Logic used by the activity definition
ActivityDefinition.kind This element is included in summaries. 0..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.
ActivityDefinition.profile 0..1 canonical(StructureDefinition) What profile the resource needs to conform to
ActivityDefinition.code 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.
ActivityDefinition.intent 0..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.
ActivityDefinition.priority 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 is included in summaries. 0..1 boolean True if the activity should not be performed
ActivityDefinition.timing[x] 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 0..1 Reference(Location) Where it should happen
ActivityDefinition.participant 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 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 1..1 string The path to the element to be set dynamically
ActivityDefinition.dynamicValue.expression 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
ActivityDefinition.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ActivityDefinition.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
ActivityDefinition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ActivityDefinition.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ActivityDefinition.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
ActivityDefinition.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ActivityDefinition.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.
ActivityDefinition.relatedArtifact.​type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
ActivityDefinition.kind Base required RequestResourceType 📍4.0.1 FHIR Std.
ActivityDefinition.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ActivityDefinition.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ActivityDefinition.priority Base required Request priority 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​type Base required ActionParticipantType 📍4.0.1 FHIR Std.
ActivityDefinition.participant.​role Base example Action participant role 📍4.0.1 FHIR Std.
ActivityDefinition.product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
ActivityDefinition.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

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()
pub-1 error ActivityDefinition If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
sqty-1 error ActivityDefinition.quantity The comparator is not used on a SimpleQuantity comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron