This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Clinical Decision Support Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
Definitions for the shareableactivitydefinition Profile.
ActivityDefinition | |||||||||||||
Element Id | ActivityDefinition | ||||||||||||
Definition | This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. | ||||||||||||
Short Display | The definition of a specific activity to be taken, independent of any particular patient or context | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.id | |||||||||||||
Element Id | ActivityDefinition.id | ||||||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||||||||
Short Display | Logical id of this artifact | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | id | ||||||||||||
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. | ||||||||||||
ActivityDefinition.meta | |||||||||||||
Element Id | ActivityDefinition.meta | ||||||||||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||||||||
Short Display | Metadata about the resource | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Meta | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.implicitRules | |||||||||||||
Element Id | ActivityDefinition.implicitRules | ||||||||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||||||
Short Display | A set of rules under which this content was created | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | uri | ||||||||||||
Is Modifier | true (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation) | ||||||||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.language | |||||||||||||
Element Id | ActivityDefinition.language | ||||||||||||
Definition | The base language in which the resource is written. | ||||||||||||
Short Display | Language of the resource content | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | IETF language tag The codes SHOULD be taken from Common Languages | ||||||||||||
Type | code | ||||||||||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.text | |||||||||||||
Element Id | ActivityDefinition.text | ||||||||||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||||||||||
Short Display | Text summary of the resource, for human interpretation | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Narrative | ||||||||||||
Alternate Names | narrative, html, xhtml, display | ||||||||||||
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.contained | |||||||||||||
Element Id | ActivityDefinition.contained | ||||||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. | ||||||||||||
Short Display | Contained, inline Resources | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Resource | ||||||||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||||||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. | ||||||||||||
ActivityDefinition.extension | |||||||||||||
Element Id | ActivityDefinition.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, 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. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.modifierExtension | |||||||||||||
Element Id | ActivityDefinition.modifierExtension | ||||||||||||
Definition | 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 manageable, 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). | ||||||||||||
Short Display | Extensions that cannot be ignored | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them) | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.url | |||||||||||||
Element Id | ActivityDefinition.url | ||||||||||||
Definition | An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers. | ||||||||||||
Short Display | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | uri | ||||||||||||
Requirements | Allows the activity definition to be referenced by a single globally unique identifier. | ||||||||||||
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.identifier | |||||||||||||
Element Id | ActivityDefinition.identifier | ||||||||||||
Definition | A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance. | ||||||||||||
Short Display | Additional identifier for the activity definition | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Identifier | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||||||
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.version | |||||||||||||
Element Id | ActivityDefinition.version | ||||||||||||
Definition | The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. | ||||||||||||
Short Display | Business version of the activity definition | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | string | ||||||||||||
Comments | There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the activity definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.name | |||||||||||||
Element Id | ActivityDefinition.name | ||||||||||||
Definition | A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. | ||||||||||||
Short Display | Name for this activity definition (computer friendly) | ||||||||||||
Cardinality | 1..1 This element is affected by the following invariants: cnl-0 | ||||||||||||
Type | string | ||||||||||||
Requirements | Support human navigation and code generation. | ||||||||||||
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.title | |||||||||||||
Element Id | ActivityDefinition.title | ||||||||||||
Definition | A short, descriptive, user-friendly title for the activity definition. | ||||||||||||
Short Display | Name for this activity definition (human friendly) | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Must Support | true | ||||||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.subtitle | |||||||||||||
Element Id | ActivityDefinition.subtitle | ||||||||||||
Definition | An explanatory or alternate title for the activity definition giving additional information about its content. | ||||||||||||
Short Display | Subordinate title of the activity definition | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.status | |||||||||||||
Element Id | ActivityDefinition.status | ||||||||||||
Definition | The status of this activity definition. Enables tracking the life-cycle of the content. | ||||||||||||
Short Display | draft | active | retired | unknown | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Terminology Binding | The lifecycle status of an artifact. The codes SHALL be taken from PublicationStatus | ||||||||||||
Type | code | ||||||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||
Comments | Allows filtering of activity definitions that are appropriate for use versus not. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.experimental | |||||||||||||
Element Id | ActivityDefinition.experimental | ||||||||||||
Definition | A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. | ||||||||||||
Short Display | For testing purposes, not real usage | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | boolean | ||||||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition. | ||||||||||||
Comments | Allows filtering of activity definitions that are appropriate for use versus not. | ||||||||||||
Meaning if Missing | If absent, this resource is treated as though it is not experimental. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.subject[x] | |||||||||||||
Element Id | ActivityDefinition.subject[x] | ||||||||||||
Definition | A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. | ||||||||||||
Short Display | Type of individual the activity definition is intended for | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). The codes SHALL be taken from Participant Resource Types; other codes may be used where these codes are not suitable | ||||||||||||
Type | Choice of: CodeableConcept, Reference(Group), canonical(EvidenceVariable) | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Comments | Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases. | ||||||||||||
Meaning if Missing | Patient | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.date | |||||||||||||
Element Id | ActivityDefinition.date | ||||||||||||
Definition | The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes. | ||||||||||||
Short Display | Date last changed | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | dateTime | ||||||||||||
Must Support | true | ||||||||||||
Alternate Names | Revision Date | ||||||||||||
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.publisher | |||||||||||||
Element Id | ActivityDefinition.publisher | ||||||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition. | ||||||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | string | ||||||||||||
Requirements | Helps establish the "authority/credibility" of the activity definition. May also allow for contact. | ||||||||||||
Alternate Names | steward | ||||||||||||
Comments | Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the activity definition. This item SHOULD be populated unless the information is available from context. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.contact | |||||||||||||
Element Id | ActivityDefinition.contact | ||||||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||||||
Short Display | Contact details for the publisher | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Must Support | true | ||||||||||||
Comments | May be a web site, an email address, a telephone number, etc. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.description | |||||||||||||
Element Id | ActivityDefinition.description | ||||||||||||
Definition | A free text natural language description of the activity definition from a consumer's perspective. | ||||||||||||
Short Display | Natural language description of the activity definition | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | markdown | ||||||||||||
Alternate Names | scope | ||||||||||||
Comments | This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the activity definition is presumed to be the predominant language in the place the activity definition was created). | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.useContext | |||||||||||||
Element Id | ActivityDefinition.useContext | ||||||||||||
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances. | ||||||||||||
Short Display | The context that the content is intended to support | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | UsageContext | ||||||||||||
Must Support | true | ||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.jurisdiction | |||||||||||||
Element Id | ActivityDefinition.jurisdiction | ||||||||||||
Definition | A legal or geographic region in which the activity definition is intended to be used. | ||||||||||||
Short Display | Intended jurisdiction for activity definition (if applicable) | ||||||||||||
Cardinality | 0..* | ||||||||||||
Terminology Binding | Countries and regions within which this artifact is targeted for use. The codes SHALL be taken from Jurisdiction; other codes may be used where these codes are not suitable | ||||||||||||
Type | CodeableConcept | ||||||||||||
Must Support | true | ||||||||||||
Comments | It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.purpose | |||||||||||||
Element Id | ActivityDefinition.purpose | ||||||||||||
Definition | Explanation of why this activity definition is needed and why it has been designed as it has. | ||||||||||||
Short Display | Why this activity definition is defined | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Comments | This element does not describe the usage of the activity definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.usage | |||||||||||||
Element Id | ActivityDefinition.usage | ||||||||||||
Definition | A detailed description of how the activity definition is used from a clinical perspective. | ||||||||||||
Short Display | Describes the clinical usage of the activity definition | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.copyright | |||||||||||||
Element Id | ActivityDefinition.copyright | ||||||||||||
Definition | A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition. | ||||||||||||
Short Display | Use and/or publishing restrictions | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | markdown | ||||||||||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content. | ||||||||||||
Alternate Names | License, Restrictions | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.approvalDate | |||||||||||||
Element Id | ActivityDefinition.approvalDate | ||||||||||||
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | ||||||||||||
Short Display | When the activity definition was approved by publisher | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | date | ||||||||||||
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.lastReviewDate | |||||||||||||
Element Id | ActivityDefinition.lastReviewDate | ||||||||||||
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | ||||||||||||
Short Display | When the activity definition was last reviewed | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | date | ||||||||||||
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. | ||||||||||||
Comments | If specified, this date follows the original approval date. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.effectivePeriod | |||||||||||||
Element Id | ActivityDefinition.effectivePeriod | ||||||||||||
Definition | The period during which the activity definition content was or is planned to be in active use. | ||||||||||||
Short Display | When the activity definition is expected to be used | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Period | ||||||||||||
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the activity definition are or are expected to be used instead. | ||||||||||||
Comments | The effective period for a activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.topic | |||||||||||||
Element Id | ActivityDefinition.topic | ||||||||||||
Definition | Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching. | ||||||||||||
Short Display | E.g. Education, Treatment, Assessment, etc. | ||||||||||||
Cardinality | 0..* | ||||||||||||
Terminology Binding | High-level categorization of the definition, used for searching, sorting, and filtering. For example codes, see DefinitionTopic | ||||||||||||
Type | CodeableConcept | ||||||||||||
Requirements | Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.author | |||||||||||||
Element Id | ActivityDefinition.author | ||||||||||||
Definition | An individiual or organization primarily involved in the creation and maintenance of the content. | ||||||||||||
Short Display | Who authored the content | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.editor | |||||||||||||
Element Id | ActivityDefinition.editor | ||||||||||||
Definition | An individual or organization primarily responsible for internal coherence of the content. | ||||||||||||
Short Display | Who edited the content | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.reviewer | |||||||||||||
Element Id | ActivityDefinition.reviewer | ||||||||||||
Definition | An individual or organization primarily responsible for review of some aspect of the content. | ||||||||||||
Short Display | Who reviewed the content | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.endorser | |||||||||||||
Element Id | ActivityDefinition.endorser | ||||||||||||
Definition | An individual or organization responsible for officially endorsing the content for use in some setting. | ||||||||||||
Short Display | Who endorsed the content | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | ContactDetail | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.relatedArtifact | |||||||||||||
Element Id | ActivityDefinition.relatedArtifact | ||||||||||||
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. | ||||||||||||
Short Display | Additional documentation, citations, etc. | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | RelatedArtifact | ||||||||||||
Requirements | Activity definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. | ||||||||||||
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.library | |||||||||||||
Element Id | ActivityDefinition.library | ||||||||||||
Definition | A reference to a Library resource containing any formal logic used by the activity definition. | ||||||||||||
Short Display | Logic used by the activity definition | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | canonical(Library) | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.kind | |||||||||||||
Element Id | ActivityDefinition.kind | ||||||||||||
Definition | A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource. | ||||||||||||
Short Display | Kind of resource | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | The kind of activity the definition is describing. The codes SHALL be taken from Request Resource Types | ||||||||||||
Type | code | ||||||||||||
Comments | May determine what types of extensions are permitted. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.profile | |||||||||||||
Element Id | ActivityDefinition.profile | ||||||||||||
Definition | A profile to which the target of the activity definition is expected to conform. | ||||||||||||
Short Display | What profile the resource needs to conform to | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | canonical(StructureDefinition) | ||||||||||||
Requirements | Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.code | |||||||||||||
Element Id | ActivityDefinition.code | ||||||||||||
Definition | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | ||||||||||||
Short Display | Detail type of activity | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | Detailed type of the activity; e.g. CBC. For example codes, see Procedure Codes (SNOMED CT) | ||||||||||||
Type | CodeableConcept | ||||||||||||
Requirements | Allows matching performed to planned as well as validation against protocols. | ||||||||||||
Comments | Tends to be less relevant for activities involving particular products. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.intent | |||||||||||||
Element Id | ActivityDefinition.intent | ||||||||||||
Definition | Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. | ||||||||||||
Short Display | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | Codes indicating the degree of authority/intentionality associated with a request. The codes SHALL be taken from RequestIntent | ||||||||||||
Type | code | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.priority | |||||||||||||
Element Id | ActivityDefinition.priority | ||||||||||||
Definition | Indicates how quickly the activity should be addressed with respect to other requests. | ||||||||||||
Short Display | routine | urgent | asap | stat | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | Identifies the level of importance to be assigned to actioning the request. The codes SHALL be taken from RequestPriority | ||||||||||||
Type | code | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.doNotPerform | |||||||||||||
Element Id | ActivityDefinition.doNotPerform | ||||||||||||
Definition | Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action. | ||||||||||||
Short Display | True if the activity should not be performed | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | boolean | ||||||||||||
Is Modifier | true (Reason: If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.) | ||||||||||||
Comments | This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestOrchestration. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.timing[x] | |||||||||||||
Element Id | ActivityDefinition.timing[x] | ||||||||||||
Definition | The timing or frequency upon which the described activity is to occur. | ||||||||||||
Short Display | When activity is to occur | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Choice of: Timing, Age, Range, Duration | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Requirements | Allows prompting for activities and detection of missed planned activities. | ||||||||||||
Comments | The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.asNeeded[x] | |||||||||||||
Element Id | ActivityDefinition.asNeeded[x] | ||||||||||||
Definition | If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. | ||||||||||||
Short Display | Preconditions for service | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. For example codes, see SNOMED CT Medication As Needed Reason Codes | ||||||||||||
Type | Choice of: boolean, CodeableConcept | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.location | |||||||||||||
Element Id | ActivityDefinition.location | ||||||||||||
Definition | Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. | ||||||||||||
Short Display | Where it should happen | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | CodeableReference(Location) | ||||||||||||
Requirements | Helps in planning of activity. | ||||||||||||
Alternate Names | facility | ||||||||||||
Comments | May reference a specific clinical location or may just identify a type of location. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.participant | |||||||||||||
Element Id | ActivityDefinition.participant | ||||||||||||
Definition | Indicates who should participate in performing the action described. | ||||||||||||
Short Display | Who should participate in the action | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | BackboneElement | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.participant.id | |||||||||||||
Element Id | ActivityDefinition.participant.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
ActivityDefinition.participant.extension | |||||||||||||
Element Id | ActivityDefinition.participant.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.participant.modifierExtension | |||||||||||||
Element Id | ActivityDefinition.participant.modifierExtension | ||||||||||||
Definition | 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 manageable, 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). | ||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.participant.type | |||||||||||||
Element Id | ActivityDefinition.participant.type | ||||||||||||
Definition | The type of participant in the action. | ||||||||||||
Short Display | careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | The type of participant in the activity. The codes SHALL be taken from ActionParticipantType | ||||||||||||
Type | code | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.participant.typeCanonical | |||||||||||||
Element Id | ActivityDefinition.participant.typeCanonical | ||||||||||||
Definition | The type of participant in the action. | ||||||||||||
Short Display | Who or what can participate | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | canonical(CapabilityStatement) | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.participant.typeReference | |||||||||||||
Element Id | ActivityDefinition.participant.typeReference | ||||||||||||
Definition | The type of participant in the action. | ||||||||||||
Short Display | Who or what can participate | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Reference(CareTeam) | ||||||||||||
Comments | When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location). | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.participant.role | |||||||||||||
Element Id | ActivityDefinition.participant.role | ||||||||||||
Definition | The role the participant should play in performing the described action. | ||||||||||||
Short Display | E.g. Nurse, Surgeon, Parent, etc. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | Defines roles played by participants for the action. For example codes, see ActionParticipantRole | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.participant.function | |||||||||||||
Element Id | ActivityDefinition.participant.function | ||||||||||||
Definition | Indicates how the actor will be involved in the action - author, reviewer, witness, etc. | ||||||||||||
Short Display | E.g. Author, Reviewer, Witness, etc. | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | null For example codes, see ActionParticipantFunction | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.product[x] | |||||||||||||
Element Id | ActivityDefinition.product[x] | ||||||||||||
Definition | Identifies the food, drug or other product being consumed or supplied in the activity. | ||||||||||||
Short Display | What's administered/supplied | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | Code describing the type of substance or medication. For example codes, see SNOMED CT Medication Codes | ||||||||||||
Type | Choice of: Reference(Medication), CodeableConcept | ||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.quantity | |||||||||||||
Element Id | ActivityDefinition.quantity | ||||||||||||
Definition | Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). | ||||||||||||
Short Display | How much is administered/consumed/supplied | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Quantity(SimpleQuantity) | ||||||||||||
Alternate Names | dose | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.dosage | |||||||||||||
Element Id | ActivityDefinition.dosage | ||||||||||||
Definition | Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. | ||||||||||||
Short Display | Detailed dosage instructions | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Dosage | ||||||||||||
Comments | If a dosage instruction is used, the definition should not specify timing or quantity. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.bodySite | |||||||||||||
Element Id | ActivityDefinition.bodySite | ||||||||||||
Definition | Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). | ||||||||||||
Short Display | What part of body to perform on | ||||||||||||
Cardinality | 0..* | ||||||||||||
Terminology Binding | A code that identifies the anatomical location. For example codes, see SNOMED CT Body Structures | ||||||||||||
Type | CodeableConcept | ||||||||||||
Requirements | Knowing where the procedure is made is important for tracking if multiple sites are possible. | ||||||||||||
Comments | Only used if not implicit in the code found in ServiceRequest.type. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.specimenRequirement | |||||||||||||
Element Id | ActivityDefinition.specimenRequirement | ||||||||||||
Definition | Defines specimen requirements for the action to be performed, such as required specimens for a lab test. | ||||||||||||
Short Display | What specimens are required to perform this action | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | canonical(SpecimenDefinition) | ||||||||||||
Requirements | Needed to represent lab order definitions. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.observationRequirement | |||||||||||||
Element Id | ActivityDefinition.observationRequirement | ||||||||||||
Definition | Defines observation requirements for the action to be performed, such as body weight or surface area. | ||||||||||||
Short Display | What observations are required to perform this action | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | canonical(ObservationDefinition) | ||||||||||||
Requirements | Needed to represent observation definitions. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.observationResultRequirement | |||||||||||||
Element Id | ActivityDefinition.observationResultRequirement | ||||||||||||
Definition | Defines the observations that are expected to be produced by the action. | ||||||||||||
Short Display | What observations must be produced by this action | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | canonical(ObservationDefinition) | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.transform | |||||||||||||
Element Id | ActivityDefinition.transform | ||||||||||||
Definition | A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input. | ||||||||||||
Short Display | Transform to apply the template | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | canonical(StructureMap) | ||||||||||||
Comments | Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.dynamicValue | |||||||||||||
Element Id | ActivityDefinition.dynamicValue | ||||||||||||
Definition | Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result. | ||||||||||||
Short Display | Dynamic aspects of the definition | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | BackboneElement | ||||||||||||
Comments | Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.dynamicValue.id | |||||||||||||
Element Id | ActivityDefinition.dynamicValue.id | ||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
ActivityDefinition.dynamicValue.extension | |||||||||||||
Element Id | ActivityDefinition.dynamicValue.extension | ||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.dynamicValue.modifierExtension | |||||||||||||
Element Id | ActivityDefinition.dynamicValue.modifierExtension | ||||||||||||
Definition | 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 manageable, 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). | ||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.dynamicValue.path | |||||||||||||
Element Id | ActivityDefinition.dynamicValue.path | ||||||||||||
Definition | The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). | ||||||||||||
Short Display | The path to the element to be set dynamically | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | string | ||||||||||||
Comments | The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation. | ||||||||||||
Invariants |
| ||||||||||||
ActivityDefinition.dynamicValue.expression | |||||||||||||
Element Id | ActivityDefinition.dynamicValue.expression | ||||||||||||
Definition | An expression specifying the value of the customized element. | ||||||||||||
Short Display | An expression that provides the dynamic value for the customization | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | Expression | ||||||||||||
Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. | ||||||||||||
Invariants |
|