Definitions for the StructureDefinition-regimen-entry-template Profile.
ActivityDefinition(regimenEntryTemplate) | |
Definition | The NCCN Order Template Profile is based upon the core FHIR PlanDefinition Resource and designed to improve the safety and effectiveness of cancer treatment protocols. |
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 | 1..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 | 1..1 |
Type | Meta |
ActivityDefinition.meta.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..0 |
Type | string |
ActivityDefinition.meta.extension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
ActivityDefinition.meta.versionId | |
Definition | On the NCCN FHIR server, this will always be in a format like [external version].[internal version]. The external version number is incremented each time the template is duplicated into a new version. The internal version number will increment with each save. Only published versions will be available from the API. |
Control | 0..0 |
Type | id |
Comments | This version number can be used for finding and retrieving specific versions of an OrderTemplate via the API. However, data consumers should use PlanDefinition.version as the primary source of version information because FHIR servers may override the Meta.versionId when a resource is copied. |
Example | General:1.1000000000000001 |
ActivityDefinition.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Control | 0..0 |
Type | instant |
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. |
ActivityDefinition.meta.profile | |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Control | 1..1 |
Type | uri |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Fixed Value | http://nccn.org/fhir/StructureDefinition/regimen-entry |
ActivityDefinition.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Control | 0..0 |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable |
Type | Coding |
Comments | The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
ActivityDefinition.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Control | 0..0 |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" For example codes, see Common Tags |
Type | Coding |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
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..0 |
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 as much as possible. |
ActivityDefinition.language | |
Definition | The base language in which the resource is written. |
Control | 0..0 |
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..0 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..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..0 |
Type | Extension |
ActivityDefinition.modifierExtension | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
Is Modifier | true |
ActivityDefinition.url | |
Definition | An absolute URL 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..0 |
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. |
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 identifer, not a resource identifier (see discussion) |
Control | 0..0 |
Type | Identifier |
Requirements | Allows externally provided and/or useable business identifiers to be easily associated with the module. |
Comments | Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this activity definition outside of FHIR, where the logical URL is not possible to use. |
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 are orderable. 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..0 |
Type | string |
Comments | There may be multiple different instances of a activity definition that have the same identifier but different versions. |
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..0 |
Type | string |
Requirements | Support human navigation & code generation. |
Comments | The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly. |
ActivityDefinition.title | |
Definition | A short, descriptive, user-friendly title for the activity definition. |
Control | 0..0 |
Type | string |
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 definition that are appropriate for use vs. not. |
ActivityDefinition.experimental | |
Definition | A flag 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..0 |
Type | boolean |
Is Modifier | true |
Requirements | Enables experimental content to be developed following the same life-cycle as a production-level activity definition would. |
Comments | Allows filtering of activity definition that are appropriate for use vs. not. |
ActivityDefinition.date | |
Definition | The date (and optionally time) when the activity definition was published. The date must change when the business version changes, if it does, 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..0 |
Type | dateTime |
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. |
ActivityDefinition.publisher | |
Definition | The name of the individual or organization that published the activity definition. |
Control | 0..0 |
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. |
Fixed Value | National Comprehensive Cancer Network |
ActivityDefinition.description | |
Definition | A free text natural language description of the activity definition from the consumer's perspective. |
Control | 0..0 |
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 | Explains why this activity definition is needed and why it has been designed as it has. |
Control | 0..0 |
Type | markdown |
Comments | This element does not describe the usage of the activity definition (See, e.g, the comments element, or relatedArtifacts), rather it's for 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..0 |
Type | string |
ActivityDefinition.approvalDate | |
Definition | The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. |
Control | 0..0 |
Type | date |
Comments | The date may be more recent than the approval date because of minor changes / editorial corrections. |
ActivityDefinition.lastReviewDate | |
Definition | The date on which the asset content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date. |
Control | 0..0 |
Type | date |
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 effective. |
Control | 0..0 |
Type | Period |
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 would 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 of code system definitions. |
Control | 0..0 |
Type | UsageContext |
Requirements | Assist in searching for appropriate content. |
Comments | When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply. |
ActivityDefinition.jurisdiction | |
Definition | A jurisdiction in which the activity definition is intended to be used. |
Control | 0..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 |
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..0 |
Binding | High-level categorization of the definition, used for searching, sorting, and filtering For example codes, see DefinitionTopic |
Type | CodeableConcept |
Requirements | Repositories must be able to determine how to categorize the 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..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..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..0 |
Type | markdown |
Requirements | Consumers of the library 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..0 |
Type | 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 resource, but not both. |
ActivityDefinition.library | |
Definition | A reference to a Library resource containing any formal logic used by the asset. |
Control | 0..0 |
Type | Reference(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 | 1..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. |
Fixed Value | MedicationRequest |
ActivityDefinition.code | |
Definition | Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. |
Control | 0..0 |
Binding | Detailed type of planned activity; e.g. CBC For example codes, see Procedure Codes (SNOMED CT) |
Type | CodeableConcept |
Requirements | Allows matching performed to planned as well as validation against protocols. |
Comments | Tends to be less relevant for activities involving particular products. |
ActivityDefinition.timing[x] | |
Definition | The period, timing or frequency upon which the described activity is to occur. |
Control | 0..0 |
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..0 |
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..0 |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: 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 for an action in the orderset 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.productCodeableConcept | |
Definition | Identifies the food, drug or other product being consumed or supplied in the activity. |
Control | 1..1 |
Binding | Concepts from RxNorm with a term type of IN, PIN, or MIN The codes SHALL be taken from RxNorm Ingredients |
Type | CodeableConcept |
Alternate Names | agent, medication |
ActivityDefinition.quantity | |
Definition | Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). |
Control | 0..0 |
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 | 1..1 |
Type | Dosage |
Comments | In the current version of the NCCN Chemotherapy Order Template Tool, if the recommended dosing changes over time (e.g. dose titration), each dosage will be listed in its own ActivityDefinition. |
ActivityDefinition.dosage.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..0 |
Type | string |
ActivityDefinition.dosage.extension (http://nccn.org/fhir/StructureDefinition/fullyStructured) | |
Definition | Whether the cycle definition is fully represented in the structured data (including extensions). |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: boolean) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
ActivityDefinition.dosage.sequence | |
Definition | Indicates the order in which the dosage instructions should be applied or interpreted. |
Control | 0..0 |
Type | integer |
Requirements | If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. |
ActivityDefinition.dosage.text | |
Definition | Free text dosage instructions e.g. SIG. |
Control | 1..1 |
Type | string |
Requirements | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. |
ActivityDefinition.dosage.additionalInstruction | |
Definition | Supplemental instruction - e.g. "with meals". |
Control | 0..0 |
Binding | A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". For example codes, see SNOMED CT Additional Dosage Instructions |
Type | CodeableConcept |
Requirements | Additional instruction such as "Swallow with plenty of water" which may or may not be coded. |
ActivityDefinition.dosage.patientInstruction | |
Definition | Instructions in terms that are understood by the patient or consumer. |
Control | 0..1 |
Type | string |
ActivityDefinition.dosage.timing | |
Definition | When medication should be administered. |
Control | 0..1 |
Type | Timing |
Requirements | The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. |
Comments | This attribute may not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing. |
ActivityDefinition.dosage.timing.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.dosage.timing.extension (http://nccn.org/fhir/StructureDefinition/daysOfCycle) | |
Definition | Days of a possibly repeating cycle on which the agent is to be administered. |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | (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) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
ActivityDefinition.dosage.timing.event | |
Definition | Identifies specific times when the event occurs. |
Control | 0..0 |
Type | dateTime |
Requirements | In an MAR, for instance, you need to take a general specification, and turn it into a precise specification. |
ActivityDefinition.dosage.timing.repeat | |
Definition | A set of rules that describe when the event is scheduled. |
Control | 0..1 |
Type | Element |
Requirements | Many timing schedules are determined by regular repetitions. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: children().count() > id.count()) tim-1: if there's a duration, there needs to be duration units (: duration.empty() or durationUnit.exists()) tim-10: If there's a timeOfDay, there cannot be be a when, or vice versa (: timeOfDay.empty() or when.empty()) tim-2: if there's a period, there needs to be period units (: period.empty() or periodUnit.exists()) tim-4: duration SHALL be a non-negative value (: duration.exists() implies duration >= 0) tim-5: period SHALL be a non-negative value (: period.exists() implies period >= 0) tim-6: If there's a periodMax, there must be a period (: periodMax.empty() or period.exists()) tim-7: If there's a durationMax, there must be a duration (: durationMax.empty() or duration.exists()) tim-8: If there's a countMax, there must be a count (: countMax.empty() or count.exists()) tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) (: offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))) |
ActivityDefinition.dosage.timing.repeat.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.dosage.timing.repeat.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.dosage.timing.repeat.boundsRange | |
Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. |
Control | 0..1 |
Type | Range |
ActivityDefinition.dosage.timing.repeat.count | |
Definition | A total count of the desired number of repetitions. |
Control | 0..1 |
Type | integer |
Requirements | Repetitions may be limited by end time or total occurrences. |
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. |
ActivityDefinition.dosage.timing.repeat.countMax | |
Definition | A maximum value for the count of the desired repetitions (e.g. do something 6-8 times). |
Control | 0..1 |
Type | integer |
ActivityDefinition.dosage.timing.repeat.duration | |
Definition | How long this thing happens for when it happens. |
Control | 0..1 |
Type | decimal |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). |
ActivityDefinition.dosage.timing.repeat.durationMax | |
Definition | The upper limit of how long this thing happens for when it happens. |
Control | 0..1 |
Type | decimal |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). |
ActivityDefinition.dosage.timing.repeat.durationUnit | |
Definition | The units of time for the duration, in UCUM units. |
Control | 0..1 |
Binding | A unit of time (units from UCUM). The codes SHALL be taken from UnitsOfTime |
Type | code |
ActivityDefinition.dosage.timing.repeat.frequency | |
Definition | The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided). |
Control | 0..1 |
Type | integer |
Default Value | 1 |
ActivityDefinition.dosage.timing.repeat.frequencyMax | |
Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. |
Control | 0..1 |
Type | integer |
ActivityDefinition.dosage.timing.repeat.period | |
Definition | Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. |
Control | 0..1 |
Type | decimal |
ActivityDefinition.dosage.timing.repeat.periodMax | |
Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. |
Control | 0..1 |
Type | decimal |
ActivityDefinition.dosage.timing.repeat.periodUnit | |
Definition | The units of time for the period in UCUM units. |
Control | 0..1 |
Binding | A unit of time (units from UCUM). The codes SHALL be taken from UnitsOfTime |
Type | code |
ActivityDefinition.dosage.timing.repeat.dayOfWeek | |
Definition | If one or more days of week is provided, then the action happens only on the specified day(s). |
Control | 0..0 |
Binding | null The codes SHALL be taken from DaysOfWeek |
Type | code |
Comments | If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek. |
ActivityDefinition.dosage.timing.repeat.timeOfDay | |
Definition | Specified time of day for action to take place. |
Control | 0..0 |
Type | time |
Comments | When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay. |
ActivityDefinition.dosage.timing.repeat.when | |
Definition | Real world events that the occurrence of the event should be tied to. |
Control | 0..0 |
Binding | Real world event that the relating to the schedule. The codes SHALL be taken from EventTiming |
Type | code |
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. |
Comments | When more than one event is listed, the event is tied to the union of the specified events. |
ActivityDefinition.dosage.timing.repeat.offset | |
Definition | The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. |
Control | 0..0 |
Type | unsignedInt |
ActivityDefinition.dosage.timing.code | |
Definition | A code for the timing schedule. Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). |
Control | 0..0 |
Binding | Code for a known / defined timing pattern. The codes SHOULD be taken from TimingAbbreviation |
Type | CodeableConcept |
Comments | BID etc are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or the a structured representation should be used (in this case, specifying the two event times). |
ActivityDefinition.dosage.asNeeded[x] | |
Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). |
Control | 0..0 |
Binding | A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. For example codes, see SNOMED CT Medication As Needed Reason Codes |
Type | Choice of: boolean, CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". |
ActivityDefinition.dosage.site | |
Definition | Body site to administer to. |
Control | 0..0 |
Binding | A coded concept describing the site location the medicine enters into or onto the body. For example codes, see SNOMED CT Anatomical Structure for Administration Site Codes |
Type | CodeableConcept |
Requirements | A coded specification of the anatomic site where the medication first enters the body. |
Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension body-site-instance. May be a summary code, or a reference to a very precise definition of the location, or both. |
ActivityDefinition.dosage.route | |
Definition | How drug should enter body. |
Control | 1..1 |
Binding | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. For example codes, see SNOMED CT Route Codes |
Type | CodeableConcept |
Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. |
ActivityDefinition.dosage.method | |
Definition | Technique for administering medication. |
Control | 0..1 |
Binding | Specifies the method of administration for an IV medication The codes SHALL be taken from IV Administration Methods |
Type | CodeableConcept |
Requirements | A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. |
Comments | Only populated for IV push and IV continuous infusion. |
ActivityDefinition.dosage.dose[x] | |
Definition | Amount of medication per dose. |
Control | 0..1 |
Type | Choice of: Range, Quantity(SimpleQuantity) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | The amount of therapeutic or other substance given at one administration event. |
Comments | How to declare an extension that can appear on either doseQuanityt OR doseRange? |
ActivityDefinition.dosage.maxDosePerPeriod | |
Definition | Upper limit on medication per unit of time. |
Control | 0..0 |
Type | Ratio |
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. |
Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day". |
ActivityDefinition.dosage.maxDosePerAdministration | |
Definition | Upper limit on medication per administration. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. |
Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg. |
ActivityDefinition.dosage.maxDosePerLifetime | |
Definition | Upper limit on medication per lifetime of the patient. |
Control | 0..0 |
Type | Quantity(SimpleQuantity) |
Requirements | The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. |
ActivityDefinition.dosage.rate[x] | |
Definition | Amount of medication per unit of time. |
Control | 0..1 |
Type | Choice of: Ratio, Range, Quantity(SimpleQuantity) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. |
Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. |
ActivityDefinition.bodySite | |
Definition | Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). |
Control | 0..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..0 |
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..0 |
Type | BackboneElement |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: 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. |