Definitions for the ehealth-activitydefinition Profile.
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..* |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) |
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 |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
ActivityDefinition.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
ActivityDefinition.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
ActivityDefinition.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have 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 in formation is added later. |
ActivityDefinition.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
ActivityDefinition.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
ActivityDefinition.extension ([CanonicalType[http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-recommendation]]) | |
Definition | Defines the recommendation state of the plan definition. |
Control | 0..1 |
Type | Extension(recommendation) (Extension Type: CodeableConcept) |
ActivityDefinition.extension ([CanonicalType[http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience]]) | |
Definition | Specifies that the plan is only intended for use in the specified organizations. Leave blank if the plan is intended for global use. |
Control | 0..* |
Type | Extension(intendedAudience) (Extension Type: Reference(ehealth-organization)) |
ActivityDefinition.extension ([CanonicalType[http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-referenceRange]]) | |
Definition | Provides guide for interpretation + Must have at least a low or a high or text |
Control | 0..* |
Type | Extension(referenceRange) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
ActivityDefinition.extension ([CanonicalType[http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role]]) | |
Definition | Maintainers of the activity definition. Identifies practitioners, care teams and organizations and their responsibility as maintainers. |
Control | 1..* |
Type | Extension(modifierRole) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
ActivityDefinition.extension ([CanonicalType[http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-quality]]) | |
Definition | An Extension |
Control | 0..* |
Type | Extension(quality) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta) |
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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this activity definition is (or will be) published. The URL SHOULD include the major version of the activity definition. For more information see Technical and Business Versions. |
Control | 0..1 |
Type | uri |
Requirements | Allows the activity definition to be referenced by a single globally unique identifier. |
Comments | Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version. |
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 |
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, e.g., to identify this activity definition outside of FHIR, where it is not possible to use the logical URI. |
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 | 1..1 |
Type | string |
Comments | There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the activity definition with the format [url]|[version]. |
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 |
Type | string |
Requirements | Support human navigation and code generation. |
Comments | The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. |
ActivityDefinition.title | |
Definition | A short, descriptive, user-friendly title for the activity definition. |
Control | 0..1 |
Type | string |
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
ActivityDefinition.status | |
Definition | The status of this activity definition. Enables tracking the life-cycle of the content. |
Control | 1..1 |
Binding | The lifecycle status of a Value Set or Concept Map. The codes SHALL be taken from PublicationStatus |
Type | code |
Is Modifier | true |
Comments | Allows filtering of activity definitions that are appropriate for use vs. not. |
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 |
Is Modifier | 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 definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental activity definition in production. |
ActivityDefinition.date | |
Definition | The date (and optionally time) when the activity definition was published. The date must change if and 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 |
Alternate Names | Revision Date |
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
ActivityDefinition.publisher | |
Definition | The name of the individual or organization that published the activity definition. |
Control | 0..1 |
Type | string |
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. |
ActivityDefinition.description | |
Definition | A free text natural language description of the activity definition from a consumer's perspective. |
Control | 0..1 |
Type | markdown |
Comments | This description can be used to capture details such as why the activity definition was built, 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 profile is presumed to be the predominant language in the place the profile was created). |
ActivityDefinition.purpose | |
Definition | Explaination of why this activity definition is needed and why it has been designed as it has. |
Control | 0..1 |
Type | markdown |
Comments | This element does not describe the usage of the activity definition Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition. |
ActivityDefinition.usage | |
Definition | A detailed description of how the asset is used from a clinical perspective. |
Control | 0..1 |
Type | string |
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 |
Comments | The 'date' element may be more recent than the approval date because of minor changes / editorial corrections. |
ActivityDefinition.lastReviewDate | |
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date. |
Control | 0..1 |
Type | date |
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. |
Comments | If specified, this is usually after the approval date. |
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 |
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the activity definition are or are expected to be used instead. |
Comments | The effective period for a activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. |
ActivityDefinition.useContext | |
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate activity definition instances. |
Control | 0..* |
Type | UsageContext |
Requirements | Assist in searching for appropriate content. |
Comments | When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply. |
ActivityDefinition.jurisdiction | |
Definition | A legal or geographic region in which the activity definition is intended to be used. |
Control | 0..* |
Binding | Countries and regions within which this artifact is targeted for use The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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. |
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 | 1..1 |
Binding | Treatment | Self-treatment The codes SHALL be taken from TopicType |
Type | CodeableConcept |
Requirements | Repositories must be able to determine how to categorize the asset so that it can be found by topical searches. |
ActivityDefinition.contributor | |
Definition | A contributor to the content of the asset, including authors, editors, reviewers, and endorsers. |
Control | 0..* |
Type | Contributor |
Requirements | Consumers of the content must be able to quickly determine who contributed to the content of the knowledge asset. |
ActivityDefinition.contact | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Type | ContactDetail |
Comments | May be a web site, an email address, a telephone number, etc. |
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 |
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 |
ActivityDefinition.relatedArtifact | |
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | RelatedArtifact(RelatedArtifact) |
Requirements | Assets 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 knowledge resource, but not both. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
ActivityDefinition.library | |
Definition | A reference to a Library resource containing any formal logic used by the asset. |
Control | 0..* |
Type | Reference(ehealth-library) |
ActivityDefinition.kind | |
Definition | A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource. |
Control | 0..1 |
Binding | The kind of activity the definition is describing The codes SHALL be taken from ResourceType |
Type | code |
Comments | May determine what types of extensions are permitted. |
ActivityDefinition.code | |
Definition | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. |
Control | 1..1 |
Binding | The codes SHALL be taken from ActivityDefinitionCode |
Type | CodeableConcept |
Requirements | Allows matching performed to planned as well as validation against protocols. |
Comments | Tends to be less relevant for activities involving particular products. |
ActivityDefinition.timing[x] | |
Definition | The period, timing or frequency upon which the described activity is to occur. |
Control | 0..1 |
Type | Choice of: Timing, dateTime, Period, Range |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Allows prompting for activities and detection of missed planned activities. |
ActivityDefinition.location | |
Definition | Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. |
Control | 0..1 |
Type | Reference(Location) |
Requirements | Helps in planning of activity. |
Alternate Names | facility |
Comments | May reference a specific clinical location or may just identify a type of location. |
ActivityDefinition.participant | |
Definition | Indicates who should participate in performing the action described. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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 |
Type | string |
ActivityDefinition.participant.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
ActivityDefinition.participant.type | |
Definition | The type of participant in the action. |
Control | 1..1 |
Binding | The type of participant in the activity The codes SHALL be taken from ActionParticipantType |
Type | code |
ActivityDefinition.participant.role | |
Definition | The role the participant should play in performing the described action. |
Control | 0..1 |
Binding | Defines roles played by participants for the action For example codes, see ActionParticipantRole |
Type | CodeableConcept |
ActivityDefinition.product[x] | |
Definition | Identifies the food, drug or other product being consumed or supplied in the activity. |
Control | 0..1 |
Binding | Code describing the type of substance or medication For example codes, see SNOMED CT Medication Codes |
Type | Choice of: Reference(Medication | Substance), CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
ActivityDefinition.quantity | |
Definition | Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Alternate Names | dose |
ActivityDefinition.dosage | |
Definition | Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. |
Control | 0..* |
Type | Dosage |
Comments | If a dosage instruction is used, the definition should not specify timing or quantity. |
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 | A code that identifies the anatomical location For example codes, see SNOMED CT Body Structures |
Type | CodeableConcept |
Requirements | Knowing where the procedure is made is important for tracking if multiple sites are possible. |
Comments | Only used if not implicit in the code found in ProcedureRequest.type. |
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 | Reference(StructureMap) |
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 intent resource that would contain the result. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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 |
Type | string |
ActivityDefinition.dynamicValue.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
ActivityDefinition.dynamicValue.description | |
Definition | A brief, natural language description of the intended semantics of the dynamic value. |
Control | 0..1 |
Type | string |
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. |
Control | 0..1 |
Type | string |
ActivityDefinition.dynamicValue.language | |
Definition | The media type of the language for the expression. |
Control | 0..1 |
Type | string |
ActivityDefinition.dynamicValue.expression | |
Definition | An expression specifying the value of the customized element. |
Control | 0..1 |
Type | string |
Comments | The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. |