IG TTP-FHIR Gateway

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 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.

Allows the activity definition to be referenced by a single globally unique identifier.

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.

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.

Allows externally provided and/or usable business identifiers to be easily associated with the module.

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.

An explanatory or alternate title for the activity definition giving additional information about its content.

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.

Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition.

Allows filtering of activity definitions that are appropriate for use versus not.

The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.

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.

The name of the organization or individual that published the activity definition.

Helps establish the "authority/credibility" of the activity definition. May also allow for contact.

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.

Contact details to assist a user in finding and communicating with the publisher.

May be a web site, an email address, a telephone number, etc.

A legal or geographic region in which the activity definition is intended to be used.

It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.

Countries and regions within which this artifact is targeted for use.

Explanation of why this activity definition is needed and why it has been designed as it has.

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.

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.

Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content.

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

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.

If specified, this date follows the original approval date.

The period during which the activity definition content was or is planned to be in active use.

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.

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.

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.

Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches.

High-level categorization of the definition, used for searching, sorting, and filtering.

An individiual or organization primarily involved in the creation and maintenance of the content.

An individual or organization primarily responsible for internal coherence of the content.

An individual or organization primarily responsible for review of some aspect of the content.

An individual or organization responsible for officially endorsing the content for use in some setting.

Related artifacts such as additional documentation, justification, or bibliographic references.

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.

Each related artifact is either an attachment, or a reference to another resource, but not both.

A reference to a Library resource containing any formal logic used by the activity definition.

A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.

May determine what types of extensions are permitted.

The kind of activity the definition is describing.

A profile to which the target of the activity definition is expected to conform.

Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set.

Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.

Codes indicating the degree of authority/intentionality associated with a request.

Indicates how quickly the activity should be addressed with respect to other requests.

Identifies the level of importance to be assigned to actioning the request.

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.

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 RequestGroup.

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

Helps in planning of activity.

May reference a specific clinical location or may just identify a type of location.

Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).

Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.

If a dosage instruction is used, the definition should not specify timing or quantity.

Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).

Knowing where the procedure is made is important for tracking if multiple sites are possible.

Only used if not implicit in the code found in ServiceRequest.type.

A code that identifies the anatomical location.

Defines specimen requirements for the action to be performed, such as required specimens for a lab test.

Needed to represent lab order definitions.

Defines observation requirements for the action to be performed, such as body weight or surface area.

Needed to represent observation definitions.

Defines the observations that are expected to be produced by the action.

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.

Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.