Order Catalog Implementation Guide, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version current). This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions
Draft as of 2023-07-08 |
Definitions for the LabProcedureDefinition resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. ActivityDefinition | |
2. ActivityDefinition.url | |
Control | 10..1 |
3. ActivityDefinition.title | |
Must Support | true |
4. ActivityDefinition.title.extension | |
Control | 0..? |
Slicing | This element introduces a set of slices on ActivityDefinition.title.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
5. ActivityDefinition.title.extension:OtherTitle | |
SliceName | OtherTitle |
Control | 0..? |
Type | Extension(Translation) (Complex Extension) |
6. ActivityDefinition.date | |
Must Support | true |
7. ActivityDefinition.publisher | |
Must Support | true |
8. ActivityDefinition.contact | |
Control | 0..? |
9. ActivityDefinition.contact.telecom | |
Control | 0..? |
Must Support | true |
10. ActivityDefinition.description | |
Definition | A free text natural language description of the laboratory procedure from a consumer's perspective. A free text natural language description of the activity definition from a consumer's perspective. |
Must Support | true |
11. ActivityDefinition.effectivePeriod | |
Control | 0..? |
12. ActivityDefinition.effectivePeriod.start | |
Control | 0..? |
Must Support | true |
13. ActivityDefinition.effectivePeriod.end | |
Control | 0..? |
Must Support | true |
14. ActivityDefinition.topic | |
Must Support | true |
Comments | Examples could be lab specialties: chemistry, hormonology, hematology, bacteriology, virology .. Other examples might list medical specialty of orderer: cardiology, dermatology, gastroenterology ... DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) |
15. ActivityDefinition.kind | |
Control | 10..1 |
Fixed Value | ServiceRequest |
16. ActivityDefinition.code | |
Must Support | true |
17. ActivityDefinition.code.coding | |
Control | 0..? |
Slicing | This element introduces a set of slices on ActivityDefinition.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
18. ActivityDefinition.code.coding:orderCodeLOINC | |
SliceName | orderCodeLOINC |
Control | 0..1 |
Must Support | true |
19. ActivityDefinition.code.coding:orderCodeLOINC.system | |
Control | 0..? |
Must Support | true |
Fixed Value | http://loinc.org |
20. ActivityDefinition.doNotPerform | |
Control | 0..01 |
21. ActivityDefinition.location | |
Definition | Identifies the facility where the laboratory procedure will occur, and where the specimens will be conveyed Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
Comments | May be tha laboratory as a whole or its work area facility or a sector of it May reference a specific clinical location or may just identify a type of location. |
22. ActivityDefinition.specimenRequirement | |
Definition | Defines specimen requirements for the laboratory procedure (test or panel) to be performed. Defines specimen requirements for the action to be performed, such as required specimens for a lab test. |
Type | canonical(LabSpecimenDefinition|SpecimenDefinition) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
23. ActivityDefinition.observationRequirement | |
Definition | Defines observation requirements for the laboratory procedure (test or panel) to be performed, such as body weight or surface area. Defines observation requirements for the action to be performed, such as body weight or surface area. |
Type | canonical(InputObservationDefinition|ObservationDefinition) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
24. ActivityDefinition.observationResultRequirement | |
Definition | Defines the observations that are expected to be produced by the laboratory procedure. Defines the observations that are expected to be produced by the action. |
Type | canonical(LabObservationDefinition|ObservationDefinition) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here.
1. ActivityDefinition | |||
Definition | This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. | ||
Control | 0..* | ||
Summary | false | ||
Invariants | Defined on this element cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')) | ||
2. 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. | ||
Control | 0..1 | ||
Type | uri | ||
Is Modifier | true | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
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 its narrative along with other profiles, value sets, etc. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
3. 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. | ||
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 | ||
Type | Resource | ||
Summary | false | ||
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. | ||
4. 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 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). | ||
Control | 0..* | ||
Type | Extension | ||
Is Modifier | true | ||
Summary | true | ||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||
5. 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. | ||
Control | 10..1 | ||
Type | uri | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
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 | Defined on this element cnl-1: URL should not contain | or # - these characters make processing canonical references problematic (: exists() implies matches('^[^|# ]+$')) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
6. ActivityDefinition.title | |||
Definition | A short, descriptive, user-friendly title for the activity definition. | ||
Control | 0..1 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Obligations |
| ||
Summary | true | ||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
7. ActivityDefinition.title.extension | |||
Definition | An Extension 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 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. | ||
Control | 0..* | ||
Type | Extension | ||
Summary | false | ||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||
Slicing | This element introduces a set of slices on ActivityDefinition.title.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||
8. ActivityDefinition.title.extension:OtherTitle | |||
SliceName | OtherTitle | ||
Definition | Language translation from base language of resource to another language. 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 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. | ||
Type | Extension(Translation) (Complex Extension) | ||
Invariants | Defined on this element ele-1: (: ) ext-1: (: ) | ||
9. ActivityDefinition.status | |||
Definition | The status of this activity definition. Enables tracking the life-cycle of the content. | ||
Control | 1..1 | ||
Binding | The codes SHALL be taken from PublicationStatus The lifecycle status of an artifact. | ||
Type | code | ||
Is Modifier | true | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Comments | Allows filtering of activity definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
10. ActivityDefinition.date | |||
Definition | The date (and optionally time) when the activity definition was last significantly changed. 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. | ||
Control | 0..1 | ||
Type | dateTime | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | true | ||
Alternate Names | Revision Date | ||
Comments | The date is often not tracked until the resource is published, but may be present on draft content. 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. See guidance around (not) making local changes to elements here. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
11. ActivityDefinition.publisher | |||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition. | ||
Control | 0..1 | ||
Type | string | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Obligations |
| ||
Summary | true | ||
Requirements | Helps establish the "authority/credibility" of the activity definition. May also allow for contact. | ||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
12. ActivityDefinition.contact | |||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||
Control | 0..* | ||
Type | ContactDetail | ||
Summary | true | ||
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
13. ActivityDefinition.contact.telecom | |||
Definition | The contact details for the individual (if a name was provided) or the organization. | ||
Control | 0..* | ||
Type | ContactPoint | ||
Must Support | true | ||
Summary | true | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
14. ActivityDefinition.description | |||
Definition | A free text natural language description of the laboratory procedure from a consumer's perspective. A free text natural language description of the activity definition from a consumer's perspective. | ||
Control | 0..1 | ||
Type | markdown | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Obligations |
| ||
Summary | true | ||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
15. ActivityDefinition.effectivePeriod | |||
Definition | The period during which the activity definition content was or is planned to be in active use. | ||
Control | 0..1 | ||
Type | Period | ||
Summary | true | ||
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 an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
16. ActivityDefinition.effectivePeriod.start | |||
Definition | The start of the period. The boundary is inclusive. | ||
Control | 0..1 This element is affected by the following invariants: per-1 | ||
Type | dateTime | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | true | ||
Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
17. ActivityDefinition.effectivePeriod.end | |||
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||
Control | 0..1 This element is affected by the following invariants: per-1 | ||
Type | dateTime | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | true | ||
Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
18. 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. | ||
Control | 0..* | ||
Binding | For example codes, see DefinitionTopic High-level categorization of the definition, used for searching, sorting, and filtering. | ||
Type | CodeableConcept | ||
Must Support | true | ||
Summary | false | ||
Requirements | Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches. | ||
Comments | Examples could be lab specialties: chemistry, hormonology, hematology, bacteriology, virology .. Other examples might list medical specialty of orderer: cardiology, dermatology, gastroenterology ... DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic) | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
19. ActivityDefinition.kind | |||
Definition | A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. | ||
Control | 10..1 | ||
Binding | The codes SHALL be taken from RequestResourceTypes The kind of activity the definition is describing. | ||
Type | code | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
Comments | The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created may determine what types of extensions are permitted. | ||
Fixed Value | ServiceRequest | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
20. ActivityDefinition.code | |||
Definition | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | ||
Control | 0..1 | ||
Binding | For example codes, see ProcedureCodesSNOMEDCT Detailed type of the activity; e.g. CBC. | ||
Type | CodeableConcept | ||
Must Support | true | ||
Summary | true | ||
Requirements | Allows matching performed to planned as well as validation against protocols. | ||
Comments | Tends to be less relevant for activities involving particular products. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
21. ActivityDefinition.code.coding | |||
Definition | A reference to a code defined by a terminology system. | ||
Control | 0..* | ||
Type | Coding | ||
Summary | true | ||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
Slicing | This element introduces a set of slices on ActivityDefinition.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||
22. ActivityDefinition.code.coding:orderCodeLOINC | |||
SliceName | orderCodeLOINC | ||
Definition | A reference to a code defined by a terminology system. | ||
Control | 0..1* | ||
Type | Coding | ||
Must Support | true | ||
Summary | true | ||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
23. ActivityDefinition.code.coding:orderCodeLOINC.system | |||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Control | 0..1 | ||
Type | uri | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | true | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. | ||
Fixed Value | http://loinc.org | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
24. 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. | ||
Control | 0..01 | ||
Type | boolean | ||
Is Modifier | true | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Summary | true | ||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
25. ActivityDefinition.location | |||
Definition | Identifies the facility where the laboratory procedure will occur, and where the specimens will be conveyed Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. | ||
Control | 0..1 | ||
Type | CodeableReference(Location) | ||
Summary | false | ||
Requirements | Helps in planning of activity. | ||
Alternate Names | facility | ||
Comments | May be tha laboratory as a whole or its work area facility or a sector of it May reference a specific clinical location or may just identify a type of location. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
26. ActivityDefinition.specimenRequirement | |||
Definition | Defines specimen requirements for the laboratory procedure (test or panel) to be performed. Defines specimen requirements for the action to be performed, such as required specimens for a lab test. | ||
Control | 0..* | ||
Type | canonical(LabSpecimenDefinition|SpecimenDefinition) | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | false | ||
Requirements | Needed to represent lab order definitions. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
27. ActivityDefinition.observationRequirement | |||
Definition | Defines observation requirements for the laboratory procedure (test or panel) to be performed, such as body weight or surface area. Defines observation requirements for the action to be performed, such as body weight or surface area. | ||
Control | 0..* | ||
Type | canonical(InputObservationDefinition|ObservationDefinition) | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | false | ||
Requirements | Needed to represent observation definitions. | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
28. ActivityDefinition.observationResultRequirement | |||
Definition | Defines the observations that are expected to be produced by the laboratory procedure. Defines the observations that are expected to be produced by the action. | ||
Control | 0..* | ||
Type | canonical(LabObservationDefinition|ObservationDefinition) | ||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
Must Support | true | ||
Summary | false | ||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
1. ActivityDefinition | ||||
Definition | This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context. | |||
Control | 0..* | |||
Summary | false | |||
2. ActivityDefinition.id | ||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||
Control | 0..1 | |||
Type | id | |||
Summary | true | |||
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. | |||
3. 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. | |||
Control | 0..1 | |||
Type | Meta | |||
Summary | true | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
4. 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. | |||
Control | 0..1 | |||
Type | uri | |||
Is Modifier | true | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
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 its narrative along with other profiles, value sets, etc. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
5. ActivityDefinition.language | ||||
Definition | The base language in which the resource is written. | |||
Control | 0..1 | |||
Binding | The codes SHALL be taken from AllLanguages IETF language tag for a human languag | |||
Type | code | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
6. 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. | |||
Control | 0..1 This element is affected by the following invariants: dom-6 | |||
Type | Narrative | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
7. 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. | |||
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 | |||
Type | Resource | |||
Summary | false | |||
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. | |||
8. 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 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. | |||
Control | 0..* | |||
Type | Extension | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||
9. 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 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). | |||
Control | 0..* | |||
Type | Extension | |||
Is Modifier | true | |||
Summary | true | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||
10. 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. | |||
Control | 1..1 | |||
Type | uri | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
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 | Defined on this element cnl-1: URL should not contain | or # - these characters make processing canonical references problematic (: exists() implies matches('^[^|# ]+$')) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
11. 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. | |||
Note | This is a business identifier, not a resource identifier (see discussion) | |||
Control | 0..* | |||
Type | Identifier | |||
Summary | 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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
12. 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. | |||
Note | This is a business versionId, not a resource version id (see discussion) | |||
Control | 0..1 | |||
Type | string | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
13. ActivityDefinition.versionAlgorithm[x] | ||||
Definition | Indicates the mechanism used to compare versions to determine which is more current. | |||
Control | 0..1 | |||
Binding | The codes SHALL be taken from VersionAlgorithm; other codes may be used where these codes are not suitable | |||
Type | Choice of: string, Coding | |||
[x] Note | See Choice of Data Types for further information about how to use [x] | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
14. 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. | |||
Control | 0..1 This element is affected by the following invariants: cnl-0 | |||
Type | string | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
15. ActivityDefinition.title | ||||
Definition | A short, descriptive, user-friendly title for the activity definition. | |||
Control | 0..1 | |||
Type | string | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Must Support | true | |||
Obligations |
| |||
Summary | true | |||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
16. ActivityDefinition.title.id | ||||
Definition | unique id for the element within a resource (for internal references) | |||
Control | 0..1 | |||
Type | string | |||
XML Representation | In the XML format, this property is represented as an attribute. | |||
Summary | false | |||
17. ActivityDefinition.title.extension | ||||
Definition | An Extension | |||
Control | 0..* | |||
Type | Extension | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||
Slicing | This element introduces a set of slices on ActivityDefinition.title.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| |||
18. ActivityDefinition.title.extension:OtherTitle | ||||
SliceName | OtherTitle | |||
Definition | Language translation from base language of resource to another language. | |||
Control | 0..* | |||
Type | Extension(Translation) (Complex Extension) | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||
19. ActivityDefinition.title.value | ||||
Definition | The actual value | |||
Control | 0..1 | |||
Type | string | |||
XML Representation | In the XML format, this property is represented as an attribute. | |||
Summary | false | |||
Max Length | 1048576 | |||
20. ActivityDefinition.subtitle | ||||
Definition | An explanatory or alternate title for the activity definition giving additional information about its content. | |||
Control | 0..1 | |||
Type | string | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Obligations |
| |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
21. ActivityDefinition.status | ||||
Definition | The status of this activity definition. Enables tracking the life-cycle of the content. | |||
Control | 1..1 | |||
Binding | The codes SHALL be taken from PublicationStatus The lifecycle status of an artifact | |||
Type | code | |||
Is Modifier | true | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
Comments | Allows filtering of activity definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
22. 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. | |||
Control | 0..1 | |||
Type | boolean | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
23. 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. | |||
Control | 0..1 | |||
Binding | The codes SHALL be taken from ParticipantResourceTypes; other codes may be used where these codes are not suitable The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.) | |||
Type | Choice of: CodeableConcept, Reference(Group|MedicinalProductDefinition|SubstanceDefinition|AdministrableProductDefinition|ManufacturedItemDefinition|PackagedProductDefinition), canonical(EvidenceVariable) | |||
[x] Note | See Choice of Data Types for further information about how to use [x] | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
24. ActivityDefinition.date | ||||
Definition | The date (and optionally time) when the activity definition was last significantly changed. 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. | |||
Control | 0..1 | |||
Type | dateTime | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Must Support | true | |||
Summary | true | |||
Alternate Names | Revision Date | |||
Comments | The date is often not tracked until the resource is published, but may be present on draft content. 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. See guidance around (not) making local changes to elements here. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
25. ActivityDefinition.publisher | ||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition. | |||
Control | 0..1 | |||
Type | string | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Must Support | true | |||
Obligations |
| |||
Summary | true | |||
Requirements | Helps establish the "authority/credibility" of the activity definition. May also allow for contact. | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
26. ActivityDefinition.contact | ||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | |||
Control | 0..* | |||
Type | ContactDetail | |||
Summary | true | |||
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. | |||
27. ActivityDefinition.contact.id | ||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
Control | 0..1 This element is affected by the following invariants: ele-1 | |||
Type | id | |||
XML Representation | In the XML format, this property is represented as an attribute. | |||
Summary | false | |||
28. ActivityDefinition.contact.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 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. | |||
Control | 0..* | |||
Type | Extension | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||
Slicing | This element introduces a set of slices on ActivityDefinition.contact.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| |||
29. ActivityDefinition.contact.name | ||||
Definition | The name of an individual to contact. | |||
Control | 0..1 | |||
Type | string | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
Comments | If there is no named individual, the telecom information is for the organization as a whole. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
30. ActivityDefinition.contact.telecom | ||||
Definition | The contact details for the individual (if a name was provided) or the organization. | |||
Control | 0..* | |||
Type | ContactPoint | |||
Must Support | true | |||
Summary | true | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
31. ActivityDefinition.description | ||||
Definition | A free text natural language description of the laboratory procedure from a consumer's perspective. | |||
Control | 0..1 | |||
Type | markdown | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Must Support | true | |||
Obligations |
| |||
Summary | true | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
32. 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. | |||
Control | 0..* | |||
Type | UsageContext | |||
Summary | 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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
33. ActivityDefinition.jurisdiction | ||||
Definition | A legal or geographic region in which the activity definition is intended to be used. | |||
Control | 0..* | |||
Binding | The codes SHALL be taken from JurisdictionValueSet; other codes may be used where these codes are not suitable Countries and regions within which this artifact is targeted for use | |||
Type | CodeableConcept | |||
Obligations |
| |||
Standards Status | Deprecated (from Trial Use) | |||
Summary | 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. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
34. ActivityDefinition.purpose | ||||
Definition | Explanation of why this activity definition is needed and why it has been designed as it has. | |||
Control | 0..1 | |||
Type | markdown | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Obligations |
| |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
35. ActivityDefinition.usage | ||||
Definition | A detailed description of how the activity definition is used from a clinical perspective. | |||
Control | 0..1 | |||
Type | markdown | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Obligations |
| |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
36. 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. | |||
Control | 0..1 | |||
Type | markdown | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Obligations |
| |||
Summary | false | |||
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 | |||
Comments | The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
37. ActivityDefinition.copyrightLabel | ||||
Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). | |||
Control | 0..1 | |||
Type | string | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Obligations |
| |||
Summary | false | |||
Requirements | Defines the content expected to be rendered in all representations of the artifact. | |||
Comments | The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
38. 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. | |||
Control | 0..1 | |||
Type | date | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | false | |||
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements here. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
39. 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. | |||
Control | 0..1 | |||
Type | date | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | false | |||
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. See guidance around (not) making local changes to elements here. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
40. ActivityDefinition.effectivePeriod | ||||
Definition | The period during which the activity definition content was or is planned to be in active use. | |||
Control | 0..1 | |||
Type | Period | |||
Summary | true | |||
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 an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here. | |||
41. ActivityDefinition.effectivePeriod.id | ||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
Control | 0..1 This element is affected by the following invariants: ele-1 | |||
Type | id | |||
XML Representation | In the XML format, this property is represented as an attribute. | |||
Summary | false | |||
42. ActivityDefinition.effectivePeriod.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 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. | |||
Control | 0..* | |||
Type | Extension | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||
Slicing | This element introduces a set of slices on ActivityDefinition.effectivePeriod.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| |||
43. ActivityDefinition.effectivePeriod.start | ||||
Definition | The start of the period. The boundary is inclusive. | |||
Control | 0..1 This element is affected by the following invariants: per-1 | |||
Type | dateTime | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Must Support | true | |||
Summary | true | |||
Comments | If the low element is missing, the meaning is that the low boundary is not known. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
44. ActivityDefinition.effectivePeriod.end | ||||
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | |||
Control | 0..1 This element is affected by the following invariants: per-1 | |||
Type | dateTime | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Must Support | true | |||
Summary | true | |||
Comments | The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | |||
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
45. 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. | |||
Control | 0..* | |||
Binding | For example codes, see DefinitionTopic High-level categorization of the definition, used for searching, sorting, and filtering | |||
Type | CodeableConcept | |||
Must Support | true | |||
Summary | false | |||
Requirements | Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches. | |||
Comments | Examples could be lab specialties: chemistry, hormonology, hematology, bacteriology, virology .. Other examples might list medical specialty of orderer: cardiology, dermatology, gastroenterology ... | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
46. ActivityDefinition.author | ||||
Definition | An individiual or organization primarily involved in the creation and maintenance of the content. | |||
Control | 0..* | |||
Type | ContactDetail | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
47. ActivityDefinition.editor | ||||
Definition | An individual or organization primarily responsible for internal coherence of the content. | |||
Control | 0..* | |||
Type | ContactDetail | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
48. ActivityDefinition.reviewer | ||||
Definition | An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content. | |||
Control | 0..* | |||
Type | ContactDetail | |||
Summary | false | |||
Comments | See guidance around (not) making local changes to elements here. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
49. ActivityDefinition.endorser | ||||
Definition | An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting. | |||
Control | 0..* | |||
Type | ContactDetail | |||
Summary | false | |||
Comments | See guidance around (not) making local changes to elements here. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
50. ActivityDefinition.relatedArtifact | ||||
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. | |||
Control | 0..* | |||
Type | RelatedArtifact | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
51. ActivityDefinition.library | ||||
Definition | A reference to a Library resource containing any formal logic used by the activity definition. | |||
Control | 0..* | |||
Type | canonical(Library) | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
52. ActivityDefinition.kind | ||||
Definition | A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. | |||
Control | 1..1 | |||
Binding | The codes SHALL be taken from RequestResourceTypes The kind of activity the definition is describing | |||
Type | code | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
Comments | The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created may determine what types of extensions are permitted. | |||
Fixed Value | ServiceRequest | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
53. ActivityDefinition.profile | ||||
Definition | A profile to which the target of the activity definition is expected to conform. | |||
Control | 0..1 | |||
Type | canonical(StructureDefinition) | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | false | |||
Requirements | Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
54. ActivityDefinition.code | ||||
Definition | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||
Control | 0..1 | |||
Binding | For example codes, see ProcedureCodesSNOMEDCT Detailed type of the activity; e.g. CBC | |||
Type | CodeableConcept | |||
Must Support | true | |||
Summary | true | |||
Requirements | Allows matching performed to planned as well as validation against protocols. | |||
Comments | Tends to be less relevant for activities involving particular products. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
55. ActivityDefinition.code.id | ||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
Control | 0..1 This element is affected by the following invariants: ele-1 | |||
Type | id | |||
XML Representation | In the XML format, this property is represented as an attribute. | |||
Summary | false | |||
56. ActivityDefinition.code.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 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. | |||
Control | 0..* | |||
Type | Extension | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||
Slicing | This element introduces a set of slices on ActivityDefinition.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| |||
57. ActivityDefinition.code.coding | ||||
Definition | A reference to a code defined by a terminology system. | |||
Control | 0..* | |||
Type | Coding | |||
Summary | true | |||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
Slicing | This element introduces a set of slices on ActivityDefinition.code.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
| |||
58. ActivityDefinition.code.coding:orderCodeLOINC | ||||
SliceName | orderCodeLOINC | |||
Definition | A reference to a code defined by a terminology system. | |||
Control | 0..1 | |||
Type | Coding | |||
Must Support | true | |||
Summary | true | |||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
59. ActivityDefinition.code.coding:orderCodeLOINC.id | ||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||
Control | 0..1 This element is affected by the following invariants: ele-1 | |||
Type | id | |||
XML Representation | In the XML format, this property is represented as an attribute. | |||
Summary | false | |||
60. ActivityDefinition.code.coding:orderCodeLOINC.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 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. | |||
Control | 0..* | |||
Type | Extension | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||
Slicing | This element introduces a set of slices on ActivityDefinition.code.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| |||
61. ActivityDefinition.code.coding:orderCodeLOINC.system | ||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | |||
Control | 0..1 | |||
Type | uri | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Must Support | true | |||
Summary | true | |||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | |||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. | |||
Fixed Value | http://loinc.org | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
62. ActivityDefinition.code.coding:orderCodeLOINC.version | ||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | |||
Note | This is a business versionId, not a resource version id (see discussion) | |||
Control | 0..1 | |||
Type | string | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
63. ActivityDefinition.code.coding:orderCodeLOINC.code | ||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | |||
Control | 0..1 This element is affected by the following invariants: cod-1 | |||
Type | code | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Obligations |
| |||
Summary | true | |||
Requirements | Need to refer to a particular code in the system. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
64. ActivityDefinition.code.coding:orderCodeLOINC.display | ||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||
Control | 0..1 This element is affected by the following invariants: cod-1 | |||
Type | string | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Obligations |
| |||
Summary | true | |||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
65. ActivityDefinition.code.coding:orderCodeLOINC.userSelected | ||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | |||
Control | 0..1 | |||
Type | boolean | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | |||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
66. ActivityDefinition.code.text | ||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | |||
Control | 0..1 | |||
Type | string | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Obligations |
| |||
Summary | true | |||
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | |||
Comments | Very often the text is the same as a displayName of one of the codings. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
67. ActivityDefinition.intent | ||||
Definition | Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. | |||
Control | 0..1 | |||
Binding | The codes SHALL be taken from RequestIntent Codes indicating the degree of authority/intentionality associated with a request | |||
Type | code | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
68. ActivityDefinition.priority | ||||
Definition | Indicates how quickly the activity should be addressed with respect to other requests. | |||
Control | 0..1 | |||
Binding | The codes SHALL be taken from RequestPriority Identifies the level of importance to be assigned to actioning the request | |||
Type | code | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
69. 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. | |||
Control | 0..0 | |||
Type | boolean | |||
Is Modifier | true | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
70. ActivityDefinition.timing[x] | ||||
Definition | The timing or frequency upon which the described activity is to occur. | |||
Control | 0..1 | |||
Type | Choice of: Timing, Age, Range, Duration | |||
[x] Note | See Choice of Data Types for further information about how to use [x] | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
71. 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. | |||
Control | 0..1 | |||
Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc | |||
Type | Choice of: boolean, CodeableConcept | |||
[x] Note | See Choice of Data Types for further information about how to use [x] | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | true | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
72. ActivityDefinition.location | ||||
Definition | Identifies the facility where the laboratory procedure will occur, and where the specimens will be conveyed | |||
Control | 0..1 | |||
Type | CodeableReference(Location) | |||
Summary | false | |||
Requirements | Helps in planning of activity. | |||
Alternate Names | facility | |||
Comments | May be tha laboratory as a whole or its work area facility or a sector of it | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
73. ActivityDefinition.participant | ||||
Definition | Indicates who should participate in performing the action described. | |||
Control | 0..* | |||
Type | BackboneElement | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
74. 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. | |||
Control | 0..1 This element is affected by the following invariants: ele-1 | |||
Type | string | |||
XML Representation | In the XML format, this property is represented as an attribute. | |||
Summary | false | |||
75. 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 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. | |||
Control | 0..* | |||
Type | Extension | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||
76. 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 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). | |||
Control | 0..* | |||
Type | Extension | |||
Is Modifier | true | |||
Summary | true | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||
77. ActivityDefinition.participant.type | ||||
Definition | The type of participant in the action. | |||
Control | 0..1 | |||
Binding | The codes SHALL be taken from ActionParticipantType The type of participant in the activity | |||
Type | code | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
78. ActivityDefinition.participant.typeCanonical | ||||
Definition | The type of participant in the action. | |||
Control | 0..1 | |||
Type | canonical(CapabilityStatement) | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
79. ActivityDefinition.participant.typeReference | ||||
Definition | The type of participant in the action. | |||
Control | 0..1 | |||
Type | Reference(CareTeam|Device|DeviceDefinition|Endpoint|Group|HealthcareService|Location|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
80. ActivityDefinition.participant.role | ||||
Definition | The role the participant should play in performing the described action. | |||
Control | 0..1 | |||
Binding | For example codes, see Action Participant Role Defines roles played by participants for the action | |||
Type | CodeableConcept | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
81. ActivityDefinition.participant.function | ||||
Definition | Indicates how the actor will be involved in the action - author, reviewer, witness, etc. | |||
Control | 0..1 | |||
Binding | For example codes, see ActionParticipantFunction | |||
Type | CodeableConcept | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
82. ActivityDefinition.product[x] | ||||
Definition | Identifies the food, drug or other product being consumed or supplied in the activity. | |||
Control | 0..1 | |||
Binding | For example codes, see SNOMEDCTMedicationCodes Code describing the type of substance or medication | |||
Type | Choice of: Reference(Medication|Ingredient|Substance|SubstanceDefinition), CodeableConcept | |||
[x] Note | See Choice of Data Types for further information about how to use [x] | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
83. ActivityDefinition.quantity | ||||
Definition | Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). | |||
Control | 0..1 | |||
Type | Quantity(SimpleQuantity) | |||
Summary | false | |||
Alternate Names | dose | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
84. ActivityDefinition.dosage | ||||
Definition | Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. | |||
Control | 0..* | |||
Type | Dosage | |||
Summary | false | |||
Comments | If a dosage instruction is used, the definition should not specify timing or quantity. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
85. ActivityDefinition.bodySite | ||||
Definition | Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). | |||
Control | 0..* | |||
Binding | For example codes, see SNOMEDCTBodyStructures A code that identifies the anatomical location | |||
Type | CodeableConcept | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
86. ActivityDefinition.specimenRequirement | ||||
Definition | Defines specimen requirements for the laboratory procedure (test or panel) to be performed. | |||
Control | 0..* | |||
Type | canonical(LabSpecimenDefinition) | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Must Support | true | |||
Summary | false | |||
Requirements | Needed to represent lab order definitions. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
87. ActivityDefinition.observationRequirement | ||||
Definition | Defines observation requirements for the laboratory procedure (test or panel) to be performed, such as body weight or surface area. | |||
Control | 0..* | |||
Type | canonical(InputObservationDefinition) | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Must Support | true | |||
Summary | false | |||
Requirements | Needed to represent observation definitions. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
88. ActivityDefinition.observationResultRequirement | ||||
Definition | Defines the observations that are expected to be produced by the laboratory procedure. | |||
Control | 0..* | |||
Type | canonical(LabObservationDefinition) | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Must Support | true | |||
Summary | false | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
89. 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. | |||
Control | 0..1 | |||
Type | canonical(StructureMap) | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
90. 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. | |||
Control | 0..* | |||
Type | BackboneElement | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
91. 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. | |||
Control | 0..1 This element is affected by the following invariants: ele-1 | |||
Type | string | |||
XML Representation | In the XML format, this property is represented as an attribute. | |||
Summary | false | |||
92. 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 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. | |||
Control | 0..* | |||
Type | Extension | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||
93. 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 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). | |||
Control | 0..* | |||
Type | Extension | |||
Is Modifier | true | |||
Summary | true | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | |||
94. 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 resolvable 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). | |||
Control | 1..1 | |||
Type | string | |||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||
Summary | false | |||
Comments | The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation. | |||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | |||
95. ActivityDefinition.dynamicValue.expression | ||||
Definition | An expression specifying the value of the customized element. | |||
Control | 1..1 | |||
Type | Expression | |||
Summary | false | |||
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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |