Canonical Resource Management Infrastructure Implementation Guide
1.0.0 - STU1 International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CRMI Publishable ActivityDefinition

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishableactivitydefinition Version: 1.0.0
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.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 1..1 ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
... Slices for extension Content/Rules for all slices
.... usage S 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
.... copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... identifier S 0..* Identifier Additional identifier for the activity definition
... date S 1..1 dateTime Date last changed
... useContext S 0..* UsageContext The context that the content is intended to support
... jurisdiction S 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable)
... purpose S 0..1 markdown Why this activity definition is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... approvalDate S 0..1 date When the activity definition was approved by publisher
... lastReviewDate S 0..1 date When the activity definition was last reviewed
... effectivePeriod S 0..1 Period When the activity definition is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
... author S 0..* ContactDetail Who authored the content
... editor S 0..* ContactDetail Who edited the content
... reviewer S 0..* ContactDetail Who reviewed the content
... endorser S 0..* ContactDetail Who endorsed the content
... relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
.... display S 0..1 string Brief description of the related artifact
.... document S 0..1 Attachment What document is being referenced
.... resource S 0..1 canonical(Resource) What resource is being referenced

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C 1..1 ActivityDefinition 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
... Slices for extension Content/Rules for all slices
.... usage S 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
.... copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... 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.

... date SΣ 1..1 dateTime Date last changed
... contact SΣ 0..* ContactDetail Contact details for the publisher
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 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 S 0..1 markdown Why this activity definition is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... approvalDate S 0..1 date When the activity definition was approved by publisher
... lastReviewDate S 0..1 date When the activity definition was last reviewed
... effectivePeriod SΣ 0..1 Period When the activity definition is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S 0..* ContactDetail Who authored the content
... editor S 0..* ContactDetail Who edited the content
... reviewer S 0..* ContactDetail Who reviewed the content
... endorser S 0..* ContactDetail Who endorsed the content
... relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
.... type Σ 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.

.... display SΣ 0..1 string Brief description of the related artifact
.... document SΣ 0..1 Attachment What document is being referenced
.... resource SΣ 0..1 canonical(Resource) What resource is being referenced
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ActivityDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ActivityDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
ActivityDefinition.relatedArtifact.typerequiredRelatedArtifactType
http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName 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-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf 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-4errorActivityDefinitionIf 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-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C 1..1 ActivityDefinition 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... usage S 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
.... copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... 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 SΣ 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] 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 SΣ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact SΣ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the activity definition
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 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 S 0..1 markdown Why this activity definition is defined
... usage 0..1 string Describes the clinical usage of the activity definition
... copyright S 0..1 markdown Use and/or publishing restrictions
... approvalDate S 0..1 date When the activity definition was approved by publisher
... lastReviewDate S 0..1 date When the activity definition was last reviewed
... effectivePeriod SΣ 0..1 Period When the activity definition is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S 0..* ContactDetail Who authored the content
... editor S 0..* ContactDetail Who edited the content
... reviewer S 0..* ContactDetail Who reviewed the content
... endorser S 0..* ContactDetail Who endorsed the content
... relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ 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.

.... label Σ 0..1 string Short label
.... display SΣ 0..1 string Brief description of the related artifact
.... citation Σ 0..1 markdown Bibliographic citation for the artifact
.... url Σ 0..1 url Where the artifact can be accessed
.... document SΣ 0..1 Attachment What document is being referenced
.... resource SΣ 0..1 canonical(Resource) What resource is being referenced
... library 0..* canonical(Library) Logic used by the activity definition
... kind Σ 0..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.

... profile 0..1 canonical(StructureDefinition) What profile the resource needs to conform to
... code Σ 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.

... 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.

... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed
... timing[x] 0..1 When activity is to occur
.... timingTiming Timing
.... timingDateTime dateTime
.... timingAge Age
.... timingPeriod Period
.... timingRange Range
.... timingDuration Duration
... location 0..1 Reference(Location) Where it should happen
... participant 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 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 1..1 string The path to the element to be set dynamically
.... expression 1..1 Expression An expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ActivityDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ActivityDefinition.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
ActivityDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ActivityDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
ActivityDefinition.relatedArtifact.typerequiredRelatedArtifactType
http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1
from the FHIR Standard
ActivityDefinition.kindrequiredRequestResourceType
http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1
from the FHIR Standard
ActivityDefinition.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ActivityDefinition.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ActivityDefinition.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ActivityDefinition.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
from the FHIR Standard
ActivityDefinition.participant.roleexampleActionParticipantRole
http://hl7.org/fhir/ValueSet/action-participant-role
from the FHIR Standard
ActivityDefinition.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
ActivityDefinition.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName 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-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf 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-4errorActivityDefinitionIf 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-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ActivityDefinition

Summary

Mandatory: 1 element
Must-Support: 21 elements

Extensions

This structure refers to these extensions:

Maturity: 3

Differential View

This structure is derived from ActivityDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 1..1 ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context
... Slices for extension Content/Rules for all slices
.... usage S 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
.... copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... identifier S 0..* Identifier Additional identifier for the activity definition
... date S 1..1 dateTime Date last changed
... useContext S 0..* UsageContext The context that the content is intended to support
... jurisdiction S 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable)
... purpose S 0..1 markdown Why this activity definition is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... approvalDate S 0..1 date When the activity definition was approved by publisher
... lastReviewDate S 0..1 date When the activity definition was last reviewed
... effectivePeriod S 0..1 Period When the activity definition is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
... author S 0..* ContactDetail Who authored the content
... editor S 0..* ContactDetail Who edited the content
... reviewer S 0..* ContactDetail Who reviewed the content
... endorser S 0..* ContactDetail Who endorsed the content
... relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
.... display S 0..1 string Brief description of the related artifact
.... document S 0..1 Attachment What document is being referenced
.... resource S 0..1 canonical(Resource) What resource is being referenced

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C 1..1 ActivityDefinition 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
... Slices for extension Content/Rules for all slices
.... usage S 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
.... copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... 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.

... date SΣ 1..1 dateTime Date last changed
... contact SΣ 0..* ContactDetail Contact details for the publisher
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 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 S 0..1 markdown Why this activity definition is defined
... copyright S 0..1 markdown Use and/or publishing restrictions
... approvalDate S 0..1 date When the activity definition was approved by publisher
... lastReviewDate S 0..1 date When the activity definition was last reviewed
... effectivePeriod SΣ 0..1 Period When the activity definition is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S 0..* ContactDetail Who authored the content
... editor S 0..* ContactDetail Who edited the content
... reviewer S 0..* ContactDetail Who reviewed the content
... endorser S 0..* ContactDetail Who endorsed the content
... relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
.... type Σ 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.

.... display SΣ 0..1 string Brief description of the related artifact
.... document SΣ 0..1 Attachment What document is being referenced
.... resource SΣ 0..1 canonical(Resource) What resource is being referenced
... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ActivityDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ActivityDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
ActivityDefinition.relatedArtifact.typerequiredRelatedArtifactType
http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName 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-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf 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-4errorActivityDefinitionIf 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-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition C 1..1 ActivityDefinition 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... usage S 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
.... copyrightLabel S 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... 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 SΣ 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] 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 SΣ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact SΣ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the activity definition
... useContext SΣ 0..* UsageContext The context that the content is intended to support
... jurisdiction SΣ 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 S 0..1 markdown Why this activity definition is defined
... usage 0..1 string Describes the clinical usage of the activity definition
... copyright S 0..1 markdown Use and/or publishing restrictions
... approvalDate S 0..1 date When the activity definition was approved by publisher
... lastReviewDate S 0..1 date When the activity definition was last reviewed
... effectivePeriod SΣ 0..1 Period When the activity definition is expected to be used
... topic S 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S 0..* ContactDetail Who authored the content
... editor S 0..* ContactDetail Who edited the content
... reviewer S 0..* ContactDetail Who reviewed the content
... endorser S 0..* ContactDetail Who endorsed the content
... relatedArtifact S 0..* RelatedArtifact Additional documentation, citations, etc.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ 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.

.... label Σ 0..1 string Short label
.... display SΣ 0..1 string Brief description of the related artifact
.... citation Σ 0..1 markdown Bibliographic citation for the artifact
.... url Σ 0..1 url Where the artifact can be accessed
.... document SΣ 0..1 Attachment What document is being referenced
.... resource SΣ 0..1 canonical(Resource) What resource is being referenced
... library 0..* canonical(Library) Logic used by the activity definition
... kind Σ 0..1 code Kind of resource
Binding: RequestResourceType (required): The kind of activity the definition is describing.

... profile 0..1 canonical(StructureDefinition) What profile the resource needs to conform to
... code Σ 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC.

... 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.

... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ 0..1 boolean True if the activity should not be performed
... timing[x] 0..1 When activity is to occur
.... timingTiming Timing
.... timingDateTime dateTime
.... timingAge Age
.... timingPeriod Period
.... timingRange Range
.... timingDuration Duration
... location 0..1 Reference(Location) Where it should happen
... participant 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 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 1..1 string The path to the element to be set dynamically
.... expression 1..1 Expression An expression that provides the dynamic value for the customization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ActivityDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ActivityDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ActivityDefinition.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
ActivityDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ActivityDefinition.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard
ActivityDefinition.relatedArtifact.typerequiredRelatedArtifactType
http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1
from the FHIR Standard
ActivityDefinition.kindrequiredRequestResourceType
http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1
from the FHIR Standard
ActivityDefinition.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ActivityDefinition.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ActivityDefinition.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ActivityDefinition.participant.typerequiredActionParticipantType
http://hl7.org/fhir/ValueSet/action-participant-type|4.0.1
from the FHIR Standard
ActivityDefinition.participant.roleexampleActionParticipantRole
http://hl7.org/fhir/ValueSet/action-participant-role
from the FHIR Standard
ActivityDefinition.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
ActivityDefinition.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
adf-0warningActivityDefinitionName 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-2errorActivityDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorActivityDefinitionIf 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-4errorActivityDefinitionIf 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-5errorActivityDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceActivityDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ActivityDefinition

Summary

Mandatory: 1 element
Must-Support: 21 elements

Extensions

This structure refers to these extensions:

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron