This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot2:
Release
6
Ballot
(2nd
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
Clinical
Decision
Support
Work
Group
|
Maturity Level : 0 | Trial Use | Use Context : Any |
The canonical URL for this profile is:
http://hl7.org/fhir/StructureDefinition/publishableactivitydefinition
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.
Note to Implementers: All of the shareable, publishable, computable, and executable profiles will be migrating to the new Canonical Resource Management
implementation guide as part of the next FHIR release. Implementers are encouraged to look there for updates, corrections and clarifications.
This
profile
was
published
on
Thu,
Jan
1,
1970
00:00+1000
00:00+0800
as
a
draft
by
HL7.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work .
This structure is derived from ShareableActivityDefinition .
Summary
Mandatory:
1
element
Must-Support:
22
elements
This indicates the differences between this profile and the base ShareableActivityDefinition structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | ShareableActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | |
|
S | 0 .. * | Identifier | Additional identifier for the activity definition |
|
S | 1..1 | dateTime | Date last changed |
|
S | 0 .. * | ContactDetail | Contact details for the publisher |
|
S | 0 .. * | UsageContext | The context that the content is intended to support |
|
S | 0 .. * | CodeableConcept | Intended jurisdiction for activity definition (if applicable) |
|
S | 0 .. 1 | markdown | Why this activity definition is defined |
|
S | 0 .. 1 | markdown | Describes the clinical usage of the activity definition |
|
S | 0 .. 1 | markdown | Use and/or publishing restrictions |
|
S | 0 .. 1 | string | Copyright holder and year(s) |
|
S | 0 .. 1 | date | When the activity definition was approved by publisher |
|
S | 0 .. 1 | date | When the activity definition was last reviewed by the publisher |
|
S | 0 .. 1 | Period | When the activity definition is expected to be used |
|
S | 0 .. * | CodeableConcept | E.g. Education, Treatment, Assessment, etc |
|
S | 0 .. * | ContactDetail | Who authored the content |
|
S | 0 .. * | ContactDetail | Who edited the content |
|
S | 0 .. * | ContactDetail | Who reviewed the content |
|
S | 0 .. * | ContactDetail | Who endorsed the content |
|
S | 0 .. * | RelatedArtifact | Additional documentation, citations, etc |
|
S | 0 .. 1 | string | Brief description of the related artifact |
|
S | 0 .. 1 | Attachment | What document is being referenced |
|
S | 0 .. 1 | canonical ( Resource ) | What artifact is being referenced |
|
S | 0 .. 1 | Reference ( Resource ) | What artifact, if not a conformance resource |
|
||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableActivityDefinition structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
C
|
1..1 | ShareableActivityDefinition |
The
definition
of
a
specific
activity
to
be
taken,
independent
of
any
particular
patient
or
context
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required ): IETF language tag for a human language
| |||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Extension
Slice: Unordered, Open by value:url |
|||||
|
S | 0..* | code |
shareable
|
computable
|
publishable
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability Value Set ( required ) |
||||
|
S | 0..* | code |
narrative
|
semi-structured
|
structured
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
||||
|
S | 0..* | (Complex) |
Additional
documentation,
review,
or
usage
guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
S
Σ
C
|
1..1 | uri |
Canonical
identifier
for
this
activity
definition,
represented
as
a
URI
(globally
unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic |
||||
|
S Σ | 0..* | Identifier |
Additional
identifier
for
the
activity
definition
|
||||
|
S Σ | 1..1 | string | Business version of the activity definition | ||||
|
S Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) |
|||||
|
string | |||||||
|
Coding | |||||||
|
S
Σ
C
|
0..1 | string | Name for this activity definition (computer friendly) | ||||
|
S Σ | 1..1 | string | Name for this activity definition (human friendly) | ||||
|
0..1 | string | Subordinate title of the activity definition | |||||
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact. |
||||
|
S Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
|
0..1 |
Type
of
individual
the
activity
definition
is
intended
for
Binding: Participant Resource Types ( extensible ): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). |
||||||
|
CodeableConcept | |||||||
|
Reference ( Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition ) | |||||||
|
canonical ( EvidenceVariable ) | |||||||
|
S Σ | 1..1 | dateTime | Date last changed | ||||
|
S Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
|
S Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
||||
|
S Σ | 1..1 | markdown | Natural language description of the activity definition | ||||
|
S Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
||||
|
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. |
||||
|
S | 0..1 | markdown | Why this activity definition is defined | ||||
|
S | 0..1 | markdown | Describes the clinical usage of the activity definition | ||||
|
S | 0..1 | markdown | Use and/or publishing restrictions | ||||
|
S | 0..1 | string | Copyright holder and year(s) | ||||
|
S | 0..1 | date | When the activity definition was approved by publisher | ||||
|
S | 0..1 | date | When the activity definition was last reviewed by the publisher | ||||
|
S Σ | 0..1 | Period | When the activity definition is expected to be used | ||||
|
S | 0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment,
etc
Binding: Definition Topic ( example ): High-level categorization of the definition, used for searching, sorting, and filtering. |
||||
|
S | 0..* | ContactDetail |
Who
authored
the
content
|
||||
|
S | 0..* | ContactDetail |
Who
edited
the
content
|
||||
|
S | 0..* | ContactDetail |
Who
reviewed
the
content
|
||||
|
S | 0..* | ContactDetail |
Who
endorsed
the
content
|
||||
|
S | 0..* | RelatedArtifact |
Additional
documentation,
citations,
etc
|
||||
|
0..1 | id | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
Slice: Unordered, Open by value:url |
|||||
|
|
1..1 | code |
documentation
|
justification
|
citation
|
predecessor
|
successor
|
derived-from
|
depends-on
|
composed-of
|
part-of
|
amends
|
amended-with
|
appends
|
appended-with
|
cites
|
cited-by
|
comments-on
|
comment-in
|
contains
|
contained-in
|
corrects
|
correction-in
|
replaces
|
replaced-with
|
retracts
|
retracted-by
|
signs
|
similar-to
|
supports
|
supported-with
|
transforms
|
transformed-into
|
transformed-with
|
documents
|
specification-of
|
created-with
|
cite-as
Binding: RelatedArtifactType ( required ): The type of relationship to the related artifact. |
||||
|
|
0..* | CodeableConcept |
Additional
classifiers
Binding: Citation Artifact Classifier ( example ): Additional classifiers for the related artifact. |
||||
|
|
0..1 | string | Short label | ||||
|
S
|
0..1 | string | Brief description of the related artifact | ||||
|
|
0..1 | markdown | Bibliographic citation for the artifact | ||||
|
S
|
0..1 | Attachment | What document is being referenced | ||||
|
S
|
0..1 | canonical ( Resource ) | What artifact is being referenced | ||||
|
S
|
0..1 | Reference ( Resource ) | What artifact, if not a conformance resource | ||||
|
|
0..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): Publication status of an artifact being referred to. |
||||
|
|
0..1 | date | Date of publication of the artifact being referred to | ||||
|
0..* | canonical ( Library ) |
Logic
used
by
the
activity
definition
|
|||||
|
Σ | 0..1 | code |
Kind
of
resource
Binding: Request Resource Types ( required ): The kind of activity the definition is describing. |
||||
|
0..1 | canonical ( StructureDefinition ) | What profile the resource needs to conform to | |||||
|
Σ | 0..1 | CodeableConcept |
Detail
type
of
activity
Binding: Procedure Codes (SNOMED CT) ( example ): Detailed type of the activity; e.g. CBC. |
||||
|
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. |
|||||
|
0..1 | code |
routine
|
urgent
|
asap
|
stat
Binding: RequestPriority ( required ): Identifies the level of importance to be assigned to actioning the request. |
|||||
|
?! Σ | 0..1 | boolean | True if the activity should not be performed | ||||
|
0..1 | When activity is to occur | ||||||
|
Timing | |||||||
|
Age | |||||||
|
Range | |||||||
|
Duration | |||||||
|
Σ | 0..1 |
Preconditions
for
service
Binding: SNOMED CT Medication As Needed Reason Codes ( example ): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. |
|||||
|
boolean | |||||||
|
CodeableConcept | |||||||
|
0..1 | CodeableReference ( Location ) | Where it should happen | |||||
|
0..* | BackboneElement |
Who
should
participate
in
the
action
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | code |
careteam
|
device
|
group
|
healthcareservice
|
location
|
organization
|
patient
|
practitioner
|
practitionerrole
|
relatedperson
Binding: Action Participant Type ( required ): The type of participant in the activity. |
|||||
|
0..1 | canonical ( CapabilityStatement ) | Who or what can participate | |||||
|
0..1 | Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |||||
|
0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent,
etc
Binding: Action Participant Role
(
example
):
Defines
roles
played
by
participants
for
the
action.
|
|||||
|
0..1 | CodeableConcept |
E.g.
Author,
Reviewer,
Witness,
etc
Binding: Action Participant Function ( example ) |
|||||
|
0..1 |
What's
administered/supplied
Binding: SNOMED CT Medication Codes ( example ): Code describing the type of substance or medication. |
||||||
|
Reference ( Medication | Ingredient | Substance | SubstanceDefinition ) | |||||||
|
CodeableConcept | |||||||
|
0..1 | SimpleQuantity | How much is administered/consumed/supplied | |||||
|
0..* | Dosage |
Detailed
dosage
instructions
|
|||||
|
0..* | CodeableConcept |
What
part
of
body
to
perform
on
Binding: SNOMED CT Body Structures ( example ): A code that identifies the anatomical location. |
|||||
|
0..* | canonical ( SpecimenDefinition ) |
What
specimens
are
required
to
perform
this
action
|
|||||
|
0..* | canonical ( ObservationDefinition ) |
What
observations
are
required
to
perform
this
action
|
|||||
|
0..* | canonical ( ObservationDefinition ) |
What
observations
must
be
produced
by
this
action
|
|||||
|
0..1 | canonical ( StructureMap ) | Transform to apply the template | |||||
|
0..* | BackboneElement |
Dynamic
aspects
of
the
definition
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
1..1 | string | The path to the element to be set dynamically | |||||
|
1..1 | Expression | An expression that provides the dynamic value for the customization | |||||
|
||||||||
<!-- PublishableActivityDefinition --><ActivityDefinition xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained>
<<a href="publishableactivitydefinition-definitions.html#ActivityDefinition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this activity definition, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the activity definition --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the activity definition --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this activity definition (computer friendly) --> <title value="[string]"/><!-- I 1..1 Name for this activity definition (human friendly) --> <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the activity definition --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage --> <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group)|canonical Type of individual the activity definition is intended for --></subject[x]> <date value="[dateTime]"/><!-- I 1..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the activity definition --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this activity definition is defined --> <usage value="[markdown]"/><!-- I 0..1 Describes the clinical usage of the activity definition --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the activity definition was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the activity definition was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the activity definition is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the content --></author> <editor><!-- I 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact> I 0..* RelatedArtifact <!-- I 0..* Additional documentation, citations, etc --> <type value="[code]"/><!-- I 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as --> <classifier><!-- I 0..* CodeableConcept Additional classifiers --></classifier> <label value="[string]"/><!-- I 0..1 Short label --> <display value="[string]"/><!-- I 0..1 Brief description of the related artifact --> <citation value="[markdown]"/><!-- I 0..1 Bibliographic citation for the artifact --> <document><!-- I 0..1 Attachment What document is being referenced --></document> <resource value="[canonical]"/><!-- I 0..1 What artifact is being referenced --> <resourceReference><!-- I 0..1 Reference(Resource) What artifact, if not a conformance resource --></resourceReference> <publicationStatus value="[code]"/><!-- I 0..1 draft | active | retired | unknown --> <publicationDate value="[date]"/><!-- I 0..1 Date of publication of the artifact being referred to --> </relatedArtifact> <library value="[canonical]"/><!-- I 0..* Logic used by the activity definition --> <kind value="[code]"/><!-- I 0..1 Kind of resource --> <profile value="[canonical]"/><!-- I 0..1 What profile the resource needs to conform to --> <code><!-- I 0..1 CodeableConcept Detail type of activity --></code> <intent value="[code]"/><!-- I 0..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option --> <priority value="[code]"/><!-- I 0..1 routine | urgent | asap | stat --> <doNotPerform value="[boolean]"/><!-- I 0..1 True if the activity should not be performed --> <timing[x]><!-- I 0..1 Timing|Age|Range|Duration When activity is to occur --></timing[x]> <asNeeded[x]><!-- I 0..1 boolean|CodeableConcept Preconditions for service --></asNeeded[x]> <location><!-- I 0..1 CodeableReference Where it should happen --></location> <participant> I 0..* BackboneElement <!-- I 0..* Who should participate in the action --><<a href="publishableactivitydefinition-definitions.html#ActivityDefinition.participant.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <type value="[code]"/><!-- I 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson --> <typeCanonical value="[canonical]"/><!-- I 0..1 Who or what can participate --> <typeReference><!-- I 0..1 Reference(CareTeam) Who or what can participate --></typeReference><</role><role><!-- I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc--></role> <function><!-- I 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc --></function> </participant> <product[x]><!-- I 0..1 Reference(Medication)|CodeableConcept What's administered/supplied --></product[x]> <quantity><!-- I 0..1 Quantity How much is administered/consumed/supplied --></quantity> <dosage><!-- I 0..* Dosage Detailed dosage instructions --></dosage> <bodySite><!-- I 0..* CodeableConcept What part of body to perform on --></bodySite> <specimenRequirement value="[canonical]"/><!-- I 0..* What specimens are required to perform this action --> <observationRequirement value="[canonical]"/><!-- I 0..* What observations are required to perform this action --> <observationResultRequirement value="[canonical]"/><!-- I 0..* What observations must be produced by this action --> <transform value="[canonical]"/><!-- I 0..1 Transform to apply the template --> <dynamicValue> I 0..* BackboneElement <!-- I 0..* Dynamic aspects of the definition -->
<<a href="publishableactivitydefinition-definitions.html#ActivityDefinition.dynamicValue.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <path value="[string]"/><!-- I 1..1 The path to the element to be set dynamically --> <expression><!-- I 1..1 Expression An expression that provides the dynamic value for the customization --></expression> </dynamicValue> </ActivityDefinition>
{ // PublishableActivityDefinition
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"extension" : [ // sliced by value:url in the specified order, Open
{ // shareable | computable | publishable | executable // I
// from Element: extension
},
{ // narrative | semi-structured | structured | executable // I
// from Element: extension
},
{ // Additional documentation, review, or usage guidance // I
// from Element: extension
}
],
"<a href="publishableactivitydefinition-definitions.html#ActivityDefinition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"url" : "<uri>", // I R! Canonical identifier for this activity definition, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // IAdditional identifier for the activity definition
"version" : "<string>", // I R! Business version of the activity definition
// value[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>", // IHow to compare versions
"versionAlgorithmCoding" : { Coding }, // IHow to compare versions
"name" : "<string>", // IName for this activity definition (computer friendly)
"title" : "<string>", // I R! Name for this activity definition (human friendly)
"subtitle" : "<string>", // ISubordinate title of the activity definition
"status" : "<code>", // I R! draft | active | retired | unknown
"experimental" : <boolean>, // I R! For testing purposes, not real usage
// value[x]: Type of individual the activity definition is intended for. One of these 3:
"subjectCodeableConcept" : { CodeableConcept }, // IType of individual the activity definition is intended for
"subjectReference" : { Reference(Group) }, // IType of individual the activity definition is intended for
"subjectCanonical" : "<canonical>", // IType of individual the activity definition is intended for
"date" : "<dateTime>", // I R! Date last changed
"publisher" : "<string>", // IName of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // IContact details for the publisher
"description" : "<markdown>", // I R! Natural language description of the activity definition
"useContext" : [{ UsageContext }], // IThe context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for activity definition (if applicable)
"purpose" : "<markdown>", // IWhy this activity definition is defined
"usage" : "<markdown>", // IDescribes the clinical usage of the activity definition
"copyright" : "<markdown>", // IUse and/or publishing restrictions
"copyrightLabel" : "<string>", // ICopyright holder and year(s)
"approvalDate" : "<date>", // IWhen the activity definition was approved by publisher
"lastReviewDate" : "<date>", // IWhen the activity definition was last reviewed by the publisher
"effectivePeriod" : { Period }, // IWhen the activity definition is expected to be used
"topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
"author" : [{ ContactDetail }], // IWho authored the content
"editor" : [{ ContactDetail }], // IWho edited the content
"reviewer" : [{ ContactDetail }], // IWho reviewed the content
"endorser" : [{ ContactDetail }], // IWho endorsed the content
"relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc
"library" : ["<canonical>"], // ILogic used by the activity definition
"kind" : "<code>", // IKind of resource
"profile" : "<canonical>", // IWhat profile the resource needs to conform to
"code" : { CodeableConcept }, // IDetail type of activity
"intent" : "<code>", // Iproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
"priority" : "<code>", // Iroutine | urgent | asap | stat
"doNotPerform" : <boolean>, // ITrue if the activity should not be performed
// value[x]: When activity is to occur. One of these 4:
"timingTiming" : { Timing }, // IWhen activity is to occur
"timingAge" : { Age }, // IWhen activity is to occur
"timingRange" : { Range }, // IWhen activity is to occur
"timingDuration" : { Duration }, // IWhen activity is to occur
// value[x]: Preconditions for service. One of these 2:
"asNeededBoolean" : <boolean>, // IPreconditions for service
"asNeededCodeableConcept" : { CodeableConcept }, // IPreconditions for service
"location" : { CodeableReference(Location) }, // IWhere it should happen
"participant" : [{ BackboneElement }], // IWho should participate in the action
// value[x]: What's administered/supplied. One of these 2:
"productReference" : { Reference(Medication) }, // IWhat's administered/supplied
"productCodeableConcept" : { CodeableConcept }, // IWhat's administered/supplied
"quantity" : { Quantity(SimpleQuantity) }, // IHow much is administered/consumed/supplied
"dosage" : [{ Dosage }], // IDetailed dosage instructions
"bodySite" : [{ CodeableConcept }], // IWhat part of body to perform on
"specimenRequirement" : ["<canonical>"], // IWhat specimens are required to perform this action
"observationRequirement" : ["<canonical>"], // IWhat observations are required to perform this action
"observationResultRequirement" : ["<canonical>"], // IWhat observations must be produced by this action
"transform" : "<canonical>", // ITransform to apply the template
"dynamicValue" : [{ BackboneElement }], // IDynamic aspects of the definition
}
This structure is derived from ShareableActivityDefinition .
Differential View
This indicates the differences between this profile and the base ShareableActivityDefinition structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | ShareableActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | |
|
S | 0 .. * | Identifier | Additional identifier for the activity definition |
|
S | 1..1 | dateTime | Date last changed |
|
S | 0 .. * | ContactDetail | Contact details for the publisher |
|
S | 0 .. * | UsageContext | The context that the content is intended to support |
|
S | 0 .. * | CodeableConcept | Intended jurisdiction for activity definition (if applicable) |
|
S | 0 .. 1 | markdown | Why this activity definition is defined |
|
S | 0 .. 1 | markdown | Describes the clinical usage of the activity definition |
|
S | 0 .. 1 | markdown | Use and/or publishing restrictions |
|
S | 0 .. 1 | string | Copyright holder and year(s) |
|
S | 0 .. 1 | date | When the activity definition was approved by publisher |
|
S | 0 .. 1 | date | When the activity definition was last reviewed by the publisher |
|
S | 0 .. 1 | Period | When the activity definition is expected to be used |
|
S | 0 .. * | CodeableConcept | E.g. Education, Treatment, Assessment, etc |
|
S | 0 .. * | ContactDetail | Who authored the content |
|
S | 0 .. * | ContactDetail | Who edited the content |
|
S | 0 .. * | ContactDetail | Who reviewed the content |
|
S | 0 .. * | ContactDetail | Who endorsed the content |
|
S | 0 .. * | RelatedArtifact | Additional documentation, citations, etc |
|
S | 0 .. 1 | string | Brief description of the related artifact |
|
S | 0 .. 1 | Attachment | What document is being referenced |
|
S | 0 .. 1 | canonical ( Resource ) | What artifact is being referenced |
|
S | 0 .. 1 | Reference ( Resource ) | What artifact, if not a conformance resource |
|
||||
Snapshot View
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableActivityDefinition structure.
Name
|
Flags
|
Card.
|
Type
|
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
C
|
1..1 | ShareableActivityDefinition |
The
definition
of
a
specific
activity
to
be
taken,
independent
of
any
particular
patient
or
context
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required ): IETF language tag for a human language
| |||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Extension
Slice: Unordered, Open by value:url |
|||||
|
S | 0..* | code |
shareable
|
computable
|
publishable
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: Knowledge Capability Value Set ( required ) |
||||
|
S | 0..* | code |
narrative
|
semi-structured
|
structured
|
executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: Knowledge Representation Level ( required ) |
||||
|
S | 0..* | (Complex) |
Additional
documentation,
review,
or
usage
guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
S
Σ
C
|
1..1 | uri |
Canonical
identifier
for
this
activity
definition,
represented
as
a
URI
(globally
unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic |
||||
|
S Σ | 0..* | Identifier |
Additional
identifier
for
the
activity
definition
|
||||
|
S Σ | 1..1 | string | Business version of the activity definition | ||||
|
S Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( extensible ) |
|||||
|
string | |||||||
|
Coding | |||||||
|
S
Σ
C
|
0..1 | string | Name for this activity definition (computer friendly) | ||||
|
S Σ | 1..1 | string | Name for this activity definition (human friendly) | ||||
|
0..1 | string | Subordinate title of the activity definition | |||||
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): The lifecycle status of an artifact. |
||||
|
S Σ | 1..1 | boolean | For testing purposes, not real usage | ||||
|
0..1 |
Type
of
individual
the
activity
definition
is
intended
for
Binding: Participant Resource Types ( extensible ): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). |
||||||
|
CodeableConcept | |||||||
|
Reference ( Group | MedicinalProductDefinition | SubstanceDefinition | AdministrableProductDefinition | ManufacturedItemDefinition | PackagedProductDefinition ) | |||||||
|
canonical ( EvidenceVariable ) | |||||||
|
S Σ | 1..1 | dateTime | Date last changed | ||||
|
S Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
|
S Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
||||
|
S Σ | 1..1 | markdown | Natural language description of the activity definition | ||||
|
S Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
||||
|
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. |
||||
|
S | 0..1 | markdown | Why this activity definition is defined | ||||
|
S | 0..1 | markdown | Describes the clinical usage of the activity definition | ||||
|
S | 0..1 | markdown | Use and/or publishing restrictions | ||||
|
S | 0..1 | string | Copyright holder and year(s) | ||||
|
S | 0..1 | date | When the activity definition was approved by publisher | ||||
|
S | 0..1 | date | When the activity definition was last reviewed by the publisher | ||||
|
S Σ | 0..1 | Period | When the activity definition is expected to be used | ||||
|
S | 0..* | CodeableConcept |
E.g.
Education,
Treatment,
Assessment,
etc
Binding: Definition Topic ( example ): High-level categorization of the definition, used for searching, sorting, and filtering. |
||||
|
S | 0..* | ContactDetail |
Who
authored
the
content
|
||||
|
S | 0..* | ContactDetail |
Who
edited
the
content
|
||||
|
S | 0..* | ContactDetail |
Who
reviewed
the
content
|
||||
|
S | 0..* | ContactDetail |
Who
endorsed
the
content
|
||||
|
S | 0..* | RelatedArtifact |
Additional
documentation,
citations,
etc
|
||||
|
0..1 | id | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
Slice: Unordered, Open by value:url |
|||||
|
|
1..1 | code |
documentation
|
justification
|
citation
|
predecessor
|
successor
|
derived-from
|
depends-on
|
composed-of
|
part-of
|
amends
|
amended-with
|
appends
|
appended-with
|
cites
|
cited-by
|
comments-on
|
comment-in
|
contains
|
contained-in
|
corrects
|
correction-in
|
replaces
|
replaced-with
|
retracts
|
retracted-by
|
signs
|
similar-to
|
supports
|
supported-with
|
transforms
|
transformed-into
|
transformed-with
|
documents
|
specification-of
|
created-with
|
cite-as
Binding: RelatedArtifactType ( required ): The type of relationship to the related artifact. |
||||
|
|
0..* | CodeableConcept |
Additional
classifiers
Binding: Citation Artifact Classifier ( example ): Additional classifiers for the related artifact. |
||||
|
|
0..1 | string | Short label | ||||
|
S
|
0..1 | string | Brief description of the related artifact | ||||
|
|
0..1 | markdown | Bibliographic citation for the artifact | ||||
|
S
|
0..1 | Attachment | What document is being referenced | ||||
|
S
|
0..1 | canonical ( Resource ) | What artifact is being referenced | ||||
|
S
|
0..1 | Reference ( Resource ) | What artifact, if not a conformance resource | ||||
|
|
0..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( required ): Publication status of an artifact being referred to. |
||||
|
|
0..1 | date | Date of publication of the artifact being referred to | ||||
|
0..* | canonical ( Library ) |
Logic
used
by
the
activity
definition
|
|||||
|
Σ | 0..1 | code |
Kind
of
resource
Binding: Request Resource Types ( required ): The kind of activity the definition is describing. |
||||
|
0..1 | canonical ( StructureDefinition ) | What profile the resource needs to conform to | |||||
|
Σ | 0..1 | CodeableConcept |
Detail
type
of
activity
Binding: Procedure Codes (SNOMED CT) ( example ): Detailed type of the activity; e.g. CBC. |
||||
|
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. |
|||||
|
0..1 | code |
routine
|
urgent
|
asap
|
stat
Binding: RequestPriority ( required ): Identifies the level of importance to be assigned to actioning the request. |
|||||
|
?! Σ | 0..1 | boolean | True if the activity should not be performed | ||||
|
0..1 | When activity is to occur | ||||||
|
Timing | |||||||
|
Age | |||||||
|
Range | |||||||
|
Duration | |||||||
|
Σ | 0..1 |
Preconditions
for
service
Binding: SNOMED CT Medication As Needed Reason Codes ( example ): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. |
|||||
|
boolean | |||||||
|
CodeableConcept | |||||||
|
0..1 | CodeableReference ( Location ) | Where it should happen | |||||
|
0..* | BackboneElement |
Who
should
participate
in
the
action
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | code |
careteam
|
device
|
group
|
healthcareservice
|
location
|
organization
|
patient
|
practitioner
|
practitionerrole
|
relatedperson
Binding: Action Participant Type ( required ): The type of participant in the activity. |
|||||
|
0..1 | canonical ( CapabilityStatement ) | Who or what can participate | |||||
|
0..1 | Reference ( CareTeam | Device | DeviceDefinition | Endpoint | Group | HealthcareService | Location | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson ) | Who or what can participate | |||||
|
0..1 | CodeableConcept |
E.g.
Nurse,
Surgeon,
Parent,
etc
Binding: Action Participant Role
(
example
):
Defines
roles
played
by
participants
for
the
action.
|
|||||
|
0..1 | CodeableConcept |
E.g.
Author,
Reviewer,
Witness,
etc
Binding: Action Participant Function ( example ) |
|||||
|
0..1 |
What's
administered/supplied
Binding: SNOMED CT Medication Codes ( example ): Code describing the type of substance or medication. |
||||||
|
Reference ( Medication | Ingredient | Substance | SubstanceDefinition ) | |||||||
|
CodeableConcept | |||||||
|
0..1 | SimpleQuantity | How much is administered/consumed/supplied | |||||
|
0..* | Dosage |
Detailed
dosage
instructions
|
|||||
|
0..* | CodeableConcept |
What
part
of
body
to
perform
on
Binding: SNOMED CT Body Structures ( example ): A code that identifies the anatomical location. |
|||||
|
0..* | canonical ( SpecimenDefinition ) |
What
specimens
are
required
to
perform
this
action
|
|||||
|
0..* | canonical ( ObservationDefinition ) |
What
observations
are
required
to
perform
this
action
|
|||||
|
0..* | canonical ( ObservationDefinition ) |
What
observations
must
be
produced
by
this
action
|
|||||
|
0..1 | canonical ( StructureMap ) | Transform to apply the template | |||||
|
0..* | BackboneElement |
Dynamic
aspects
of
the
definition
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
1..1 | string | The path to the element to be set dynamically | |||||
|
1..1 | Expression | An expression that provides the dynamic value for the customization | |||||
|
||||||||
XML Template
<!-- PublishableActivityDefinition --><ActivityDefinition xmlns="http://hl7.org/fhir" > <!-- from Element: extension --> <id value="[id]"/><!-- 0..1 Logical id of this artifact --> <meta><!-- I 0..1 Meta Metadata about the resource --></meta> <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created --> <language value="[code]"/><!-- I 0..1 Language of the resource content --> <text><!-- I 0..1 Narrative Text summary of the resource, for human interpretation --></text> <contained><!-- 0..* Resource Contained, inline Resources --></contained>
<<a href="publishableactivitydefinition-definitions.html#ActivityDefinition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored --></modifierExtension> <url value="[uri]"/><!-- I 1..1 Canonical identifier for this activity definition, represented as a URI (globally unique) --> <identifier><!-- I 0..* Identifier Additional identifier for the activity definition --></identifier> <version value="[string]"/><!-- I 1..1 Business version of the activity definition --> <versionAlgorithm[x]><!-- I 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <name value="[string]"/><!-- I 0..1 Name for this activity definition (computer friendly) --> <title value="[string]"/><!-- I 1..1 Name for this activity definition (human friendly) --> <subtitle value="[string]"/><!-- I 0..1 Subordinate title of the activity definition --> <status value="[code]"/><!-- I 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- I 1..1 For testing purposes, not real usage --> <subject[x]><!-- I 0..1 CodeableConcept|Reference(Group)|canonical Type of individual the activity definition is intended for --></subject[x]> <date value="[dateTime]"/><!-- I 1..1 Date last changed --> <publisher value="[string]"/><!-- I 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- I 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- I 1..1 Natural language description of the activity definition --> <useContext><!-- I 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- I 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- I 0..1 Why this activity definition is defined --> <usage value="[markdown]"/><!-- I 0..1 Describes the clinical usage of the activity definition --> <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- I 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- I 0..1 When the activity definition was approved by publisher --> <lastReviewDate value="[date]"/><!-- I 0..1 When the activity definition was last reviewed by the publisher --> <effectivePeriod><!-- I 0..1 Period When the activity definition is expected to be used --></effectivePeriod> <topic><!-- I 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc --></topic> <author><!-- I 0..* ContactDetail Who authored the content --></author> <editor><!-- I 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- I 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- I 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact> I 0..* RelatedArtifact <!-- I 0..* Additional documentation, citations, etc --> <type value="[code]"/><!-- I 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as --> <classifier><!-- I 0..* CodeableConcept Additional classifiers --></classifier> <label value="[string]"/><!-- I 0..1 Short label --> <display value="[string]"/><!-- I 0..1 Brief description of the related artifact --> <citation value="[markdown]"/><!-- I 0..1 Bibliographic citation for the artifact --> <document><!-- I 0..1 Attachment What document is being referenced --></document> <resource value="[canonical]"/><!-- I 0..1 What artifact is being referenced --> <resourceReference><!-- I 0..1 Reference(Resource) What artifact, if not a conformance resource --></resourceReference> <publicationStatus value="[code]"/><!-- I 0..1 draft | active | retired | unknown --> <publicationDate value="[date]"/><!-- I 0..1 Date of publication of the artifact being referred to --> </relatedArtifact> <library value="[canonical]"/><!-- I 0..* Logic used by the activity definition --> <kind value="[code]"/><!-- I 0..1 Kind of resource --> <profile value="[canonical]"/><!-- I 0..1 What profile the resource needs to conform to --> <code><!-- I 0..1 CodeableConcept Detail type of activity --></code> <intent value="[code]"/><!-- I 0..1 proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option --> <priority value="[code]"/><!-- I 0..1 routine | urgent | asap | stat --> <doNotPerform value="[boolean]"/><!-- I 0..1 True if the activity should not be performed --> <timing[x]><!-- I 0..1 Timing|Age|Range|Duration When activity is to occur --></timing[x]> <asNeeded[x]><!-- I 0..1 boolean|CodeableConcept Preconditions for service --></asNeeded[x]> <location><!-- I 0..1 CodeableReference Where it should happen --></location> <participant> I 0..* BackboneElement <!-- I 0..* Who should participate in the action --><<a href="publishableactivitydefinition-definitions.html#ActivityDefinition.participant.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <type value="[code]"/><!-- I 0..1 careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson --> <typeCanonical value="[canonical]"/><!-- I 0..1 Who or what can participate --> <typeReference><!-- I 0..1 Reference(CareTeam) Who or what can participate --></typeReference><</role><role><!-- I 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc--></role> <function><!-- I 0..1 CodeableConcept E.g. Author, Reviewer, Witness, etc --></function> </participant> <product[x]><!-- I 0..1 Reference(Medication)|CodeableConcept What's administered/supplied --></product[x]> <quantity><!-- I 0..1 Quantity How much is administered/consumed/supplied --></quantity> <dosage><!-- I 0..* Dosage Detailed dosage instructions --></dosage> <bodySite><!-- I 0..* CodeableConcept What part of body to perform on --></bodySite> <specimenRequirement value="[canonical]"/><!-- I 0..* What specimens are required to perform this action --> <observationRequirement value="[canonical]"/><!-- I 0..* What observations are required to perform this action --> <observationResultRequirement value="[canonical]"/><!-- I 0..* What observations must be produced by this action --> <transform value="[canonical]"/><!-- I 0..1 Transform to apply the template --> <dynamicValue> I 0..* BackboneElement <!-- I 0..* Dynamic aspects of the definition -->
<<a href="publishableactivitydefinition-definitions.html#ActivityDefinition.dynamicValue.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension><modifierExtension><!-- I 0..* Extension Extensions that cannot be ignored even if unrecognized --></modifierExtension> <path value="[string]"/><!-- I 1..1 The path to the element to be set dynamically --> <expression><!-- I 1..1 Expression An expression that provides the dynamic value for the customization --></expression> </dynamicValue> </ActivityDefinition>
JSON Template
{ // PublishableActivityDefinition
// from Element: extension
"meta" : { Meta }, // IMetadata about the resource
"implicitRules" : "<uri>", // IA set of rules under which this content was created
"language" : "<code>", // ILanguage of the resource content
"text" : { Narrative }, // IText summary of the resource, for human interpretation
"contained" : [{ Resource }], //Contained, inline Resources
"extension" : [ // sliced by value:url in the specified order, Open
{ // shareable | computable | publishable | executable // I
// from Element: extension
},
{ // narrative | semi-structured | structured | executable // I
// from Element: extension
},
{ // Additional documentation, review, or usage guidance // I
// from Element: extension
}
],
"<a href="publishableactivitydefinition-definitions.html#ActivityDefinition.modifierExtension" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
"modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
"url" : "<uri>", // I R! Canonical identifier for this activity definition, represented as a URI (globally unique)
"identifier" : [{ Identifier }], // IAdditional identifier for the activity definition
"version" : "<string>", // I R! Business version of the activity definition
// value[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>", // IHow to compare versions
"versionAlgorithmCoding" : { Coding }, // IHow to compare versions
"name" : "<string>", // IName for this activity definition (computer friendly)
"title" : "<string>", // I R! Name for this activity definition (human friendly)
"subtitle" : "<string>", // ISubordinate title of the activity definition
"status" : "<code>", // I R! draft | active | retired | unknown
"experimental" : <boolean>, // I R! For testing purposes, not real usage
// value[x]: Type of individual the activity definition is intended for. One of these 3:
"subjectCodeableConcept" : { CodeableConcept }, // IType of individual the activity definition is intended for
"subjectReference" : { Reference(Group) }, // IType of individual the activity definition is intended for
"subjectCanonical" : "<canonical>", // IType of individual the activity definition is intended for
"date" : "<dateTime>", // I R! Date last changed
"publisher" : "<string>", // IName of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // IContact details for the publisher
"description" : "<markdown>", // I R! Natural language description of the activity definition
"useContext" : [{ UsageContext }], // IThe context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // IIntended jurisdiction for activity definition (if applicable)
"purpose" : "<markdown>", // IWhy this activity definition is defined
"usage" : "<markdown>", // IDescribes the clinical usage of the activity definition
"copyright" : "<markdown>", // IUse and/or publishing restrictions
"copyrightLabel" : "<string>", // ICopyright holder and year(s)
"approvalDate" : "<date>", // IWhen the activity definition was approved by publisher
"lastReviewDate" : "<date>", // IWhen the activity definition was last reviewed by the publisher
"effectivePeriod" : { Period }, // IWhen the activity definition is expected to be used
"topic" : [{ CodeableConcept }], // IE.g. Education, Treatment, Assessment, etc
"author" : [{ ContactDetail }], // IWho authored the content
"editor" : [{ ContactDetail }], // IWho edited the content
"reviewer" : [{ ContactDetail }], // IWho reviewed the content
"endorser" : [{ ContactDetail }], // IWho endorsed the content
"relatedArtifact" : [{ RelatedArtifact }], // IAdditional documentation, citations, etc
"library" : ["<canonical>"], // ILogic used by the activity definition
"kind" : "<code>", // IKind of resource
"profile" : "<canonical>", // IWhat profile the resource needs to conform to
"code" : { CodeableConcept }, // IDetail type of activity
"intent" : "<code>", // Iproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
"priority" : "<code>", // Iroutine | urgent | asap | stat
"doNotPerform" : <boolean>, // ITrue if the activity should not be performed
// value[x]: When activity is to occur. One of these 4:
"timingTiming" : { Timing }, // IWhen activity is to occur
"timingAge" : { Age }, // IWhen activity is to occur
"timingRange" : { Range }, // IWhen activity is to occur
"timingDuration" : { Duration }, // IWhen activity is to occur
// value[x]: Preconditions for service. One of these 2:
"asNeededBoolean" : <boolean>, // IPreconditions for service
"asNeededCodeableConcept" : { CodeableConcept }, // IPreconditions for service
"location" : { CodeableReference(Location) }, // IWhere it should happen
"participant" : [{ BackboneElement }], // IWho should participate in the action
// value[x]: What's administered/supplied. One of these 2:
"productReference" : { Reference(Medication) }, // IWhat's administered/supplied
"productCodeableConcept" : { CodeableConcept }, // IWhat's administered/supplied
"quantity" : { Quantity(SimpleQuantity) }, // IHow much is administered/consumed/supplied
"dosage" : [{ Dosage }], // IDetailed dosage instructions
"bodySite" : [{ CodeableConcept }], // IWhat part of body to perform on
"specimenRequirement" : ["<canonical>"], // IWhat specimens are required to perform this action
"observationRequirement" : ["<canonical>"], // IWhat observations are required to perform this action
"observationResultRequirement" : ["<canonical>"], // IWhat observations must be produced by this action
"transform" : "<canonical>", // ITransform to apply the template
"dynamicValue" : [{ BackboneElement }], // IDynamic aspects of the definition
}
Alternate definitions: Master Definition ( XML , JSON ), Schematron
| Path | Name | Conformance | ValueSet |
| ActivityDefinition.language | All Languages | required | All Languages |
| ActivityDefinition.versionAlgorithm[x] | Version Algorithm | extensible | Version Algorithm |
| ActivityDefinition.status | PublicationStatus | required | PublicationStatus |
| ActivityDefinition.subject[x] | Participant Resource Types | extensible | Participant Resource Types |
| ActivityDefinition.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
| ActivityDefinition.topic | Definition Topic | example | Definition Topic |
| ActivityDefinition.relatedArtifact.type | RelatedArtifactType | required | RelatedArtifactType |
| ActivityDefinition.relatedArtifact.classifier | Citation Artifact Classifier | example | Citation Artifact Classifier |
| ActivityDefinition.relatedArtifact.publicationStatus | PublicationStatus | required | PublicationStatus |
| ActivityDefinition.kind | Request Resource Types | required | Request Resource Types |
| ActivityDefinition.code | Procedure Codes (SNOMED CT) | example | Procedure Codes (SNOMED CT) |
| ActivityDefinition.intent | RequestIntent | required | RequestIntent |
| ActivityDefinition.priority | RequestPriority | required | RequestPriority |
| ActivityDefinition.asNeeded[x] | SNOMED CT Medication As Needed Reason Codes | example | SNOMED CT Medication As Needed Reason Codes |
| ActivityDefinition.participant.type | Action Participant Type | required | Action Participant Type |
| ActivityDefinition.participant.role | Action Participant Role | example |
Action
Participant
Role
|
| ActivityDefinition.participant.function | Action Participant Function | example | Action Participant Function |
| ActivityDefinition.product[x] | SNOMED CT Medication Codes | example | SNOMED CT Medication Codes |
| ActivityDefinition.bodySite | SNOMED CT Body Structures | example | SNOMED CT Body Structures |