Notice
- Important: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
- This Implementation Guide is currently in Draft and SHOULD NOT be used for development or active implementation without express direction from the NHS England Genomics Unit.
StructureDefinition ActivityDefinition
FHIR representation for a DGTS Genomic Test. This is a definitional resource and available read-only from the DGTS FHIR API.
The below profile is provided to support parsing for clients if returned through a GET request.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| http://hl7.org/fhir/StructureDefinition/ActivityDefinition | HL7 International | trial-use |
| ActivityDefinition | C | DomainResource | Element idActivityDefinitionShort description The definition of a specific activity to be taken, independent of any particular patient or context DefinitionThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idActivityDefinition.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idActivityDefinition.metaShort description Metadata about the resource DefinitionThe 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.
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idActivityDefinition.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idActivityDefinition.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idActivityDefinition.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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 information is added later.
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idActivityDefinition.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idActivityDefinition.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idActivityDefinition.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| url | Σ | 0..1 | uri | Element idActivityDefinition.urlShort description Canonical identifier for this activity definition, represented as a URI (globally unique) DefinitionAn 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.
| ||
| identifier | Σ | 0..* | Identifier | Element idActivityDefinition.identifierShort description Additional identifier for the activity definition DefinitionA 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..1 | string | Element idActivityDefinition.versionShort description Business version of the activity definition DefinitionThe 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. 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].
| ||
| name | Σ C | 0..1 | string | Element idActivityDefinition.nameShort description Name for this activity definition (computer friendly) DefinitionA 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. Support human navigation and code generation. 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. The cardinality or value of this element may be affected by these constraints: inv-0 Constraints
| ||
| title | Σ | 0..1 | string | Element idActivityDefinition.titleShort description Name for this activity definition (human friendly) DefinitionA short, descriptive, user-friendly title for the activity definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
| ||
| subtitle | 0..1 | string | Element idActivityDefinition.subtitleShort description Subordinate title of the activity definition DefinitionAn explanatory or alternate title for the activity definition giving additional information about its content. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||
| status | Σ ?! | 1..1 | codeBinding | Element idActivityDefinition.statusShort description draft | active | retired | unknown DefinitionThe status of this activity definition. Enables tracking the life-cycle of the content. Allows filtering of activity definitions that are appropriate for use versus not. The lifecycle status of an artifact.
| ||
| experimental | Σ | 0..1 | boolean | Element idActivityDefinition.experimentalShort description For testing purposes, not real usage DefinitionA 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.
| ||
| subject[x] | 0..1 | Binding | Element idActivityDefinition.subject[x]Short description Type of individual the activity definition is intended for DefinitionA code or group definition that describes the intended subject of the activity being defined. Patient The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| subjectCodeableConcept | CodeableConcept | Data type | ||||
| subjectReference | Reference(Group) | Data type | ||||
| date | Σ | 0..1 | dateTime | Element idActivityDefinition.dateShort description Date last changed Alternate namesRevision Date DefinitionThe 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.
| ||
| publisher | Σ | 0..1 | string | Element idActivityDefinition.publisherShort description Name of the publisher (organization or individual) DefinitionThe 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 | Σ | 0..* | ContactDetail | Element idActivityDefinition.contactShort description Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| description | Σ | 0..1 | markdown | Element idActivityDefinition.descriptionShort description Natural language description of the activity definition DefinitionA free text natural language description of the activity definition from a consumer's perspective. 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 activity definition is presumed to be the predominant language in the place the activity definition was created).
| ||
| useContext | Σ | 0..* | UsageContext | Element idActivityDefinition.useContextShort description The context that the content is intended to support DefinitionThe 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. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| jurisdiction | Σ | 0..* | CodeableConceptBinding | Element idActivityDefinition.jurisdictionShort description Intended jurisdiction for activity definition (if applicable) DefinitionA 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. Jurisdiction ValueSet (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| purpose | 0..1 | markdown | Element idActivityDefinition.purposeShort description Why this activity definition is defined DefinitionExplanation 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.
| |||
| usage | 0..1 | string | Element idActivityDefinition.usageShort description Describes the clinical usage of the activity definition DefinitionA detailed description of how the activity definition is used from a clinical perspective. Note that FHIR strings SHALL NOT exceed 1MB in size
| |||
| copyright | 0..1 | markdown | Element idActivityDefinition.copyrightShort description Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA 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. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |||
| approvalDate | 0..1 | date | Element idActivityDefinition.approvalDateShort description When the activity definition was approved by publisher DefinitionThe 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.
| |||
| lastReviewDate | 0..1 | date | Element idActivityDefinition.lastReviewDateShort description When the activity definition was last reviewed DefinitionThe 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.
| |||
| effectivePeriod | Σ C | 0..1 | Period | Element idActivityDefinition.effectivePeriodShort description When the activity definition is expected to be used DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| topic | 0..* | CodeableConcept | Element idActivityDefinition.topicShort description E.g. Education, Treatment, Assessment, etc. DefinitionDescriptive 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. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. High-level categorization of the definition, used for searching, sorting, and filtering. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| author | 0..* | ContactDetail | Element idActivityDefinition.authorShort description Who authored the content DefinitionAn individiual or organization primarily involved in the creation and maintenance of the content. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| editor | 0..* | ContactDetail | Element idActivityDefinition.editorShort description Who edited the content DefinitionAn individual or organization primarily responsible for internal coherence of the content. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| reviewer | 0..* | ContactDetail | Element idActivityDefinition.reviewerShort description Who reviewed the content DefinitionAn individual or organization primarily responsible for review of some aspect of the content. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| endorser | 0..* | ContactDetail | Element idActivityDefinition.endorserShort description Who endorsed the content DefinitionAn individual or organization responsible for officially endorsing the content for use in some setting. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| relatedArtifact | 0..* | RelatedArtifact | Element idActivityDefinition.relatedArtifactShort description Additional documentation, citations, etc. DefinitionRelated 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| library | 0..* | canonical(Library) | Element idActivityDefinition.libraryShort description Logic used by the activity definition DefinitionA reference to a Library resource containing any formal logic used by the activity definition.
| |||
| kind | Σ | 0..1 | codeBinding | Element idActivityDefinition.kindShort description Kind of resource DefinitionA 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. RequestResourceType (required) Constraints
| ||
| profile | 0..1 | canonical(StructureDefinition) | Element idActivityDefinition.profileShort description What profile the resource needs to conform to DefinitionA 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. canonical(StructureDefinition) Constraints
| |||
| code | Σ | 0..1 | CodeableConcept | Element idActivityDefinition.codeShort description Detail type of activity DefinitionDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. Allows matching performed to planned as well as validation against protocols. Tends to be less relevant for activities involving particular products. Detailed type of the activity; e.g. CBC. ProcedureCodes(SNOMEDCT) (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| intent | 0..1 | codeBinding | Element idActivityDefinition.intentShort description proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option DefinitionIndicates 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.
| |||
| priority | 0..1 | codeBinding | Element idActivityDefinition.priorityShort description routine | urgent | asap | stat DefinitionIndicates how quickly the activity should be addressed with respect to other requests. Identifies the level of importance to be assigned to actioning the request.
| |||
| doNotPerform | Σ ?! | 0..1 | boolean | Element idActivityDefinition.doNotPerformShort description True if the activity should not be performed DefinitionSet 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.
| ||
| timing[x] | 0..1 | Element idActivityDefinition.timing[x]Short description When activity is to occur DefinitionThe period, timing or frequency upon which the described activity is to occur. Allows prompting for activities and detection of missed planned activities. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| timingTiming | Timing | Data type | ||||
| timingDateTime | dateTime | Data type | ||||
| timingAge | Age | Data type | ||||
| timingPeriod | Period | Data type | ||||
| timingRange | Range | Data type | ||||
| timingDuration | Duration | Data type | ||||
| location | C | 0..1 | Reference(Location) | Element idActivityDefinition.locationShort description Where it should happen Alternate namesfacility DefinitionIdentifies 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| participant | 0..* | BackboneElement | Element idActivityDefinition.participantShort description Who should participate in the action DefinitionIndicates who should participate in performing the action described. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idActivityDefinition.participant.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idActivityDefinition.participant.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idActivityDefinition.participant.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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.
| ||
| type | 1..1 | codeBinding | Element idActivityDefinition.participant.typeShort description patient | practitioner | related-person | device DefinitionThe type of participant in the action. The type of participant in the activity. ActionParticipantType (required) Constraints
| |||
| role | 0..1 | CodeableConcept | Element idActivityDefinition.participant.roleShort description E.g. Nurse, Surgeon, Parent, etc. DefinitionThe role the participant should play in performing the described action. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Defines roles played by participants for the action. ActionParticipantRole (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| product[x] | 0..1 | Element idActivityDefinition.product[x]Short description What's administered/supplied DefinitionIdentifies the food, drug or other product being consumed or supplied in the activity. Code describing the type of substance or medication. SNOMEDCTMedicationCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| productCodeableConcept | CodeableConcept | Data type | ||||
| productReference | Reference(Medication | Substance) | Data type | ||||
| quantity | C | 0..1 | SimpleQuantity | Element idActivityDefinition.quantityShort description How much is administered/consumed/supplied Alternate namesdose DefinitionIdentifies the quantity expected to be consumed at once (per dose, per meal, etc.). The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| dosage | 0..* | Dosage | Element idActivityDefinition.dosageShort description Detailed dosage instructions DefinitionProvides 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.
| |||
| bodySite | 0..* | CodeableConcept | Element idActivityDefinition.bodySiteShort description What part of body to perform on DefinitionIndicates 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. SNOMEDCTBodyStructures (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| specimenRequirement | C | 0..* | Reference(SpecimenDefinition) | Element idActivityDefinition.specimenRequirementShort description What specimens are required to perform this action DefinitionDefines specimen requirements for the action to be performed, such as required specimens for a lab test. Needed to represent lab order definitions. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| observationRequirement | C | 0..* | Reference(ObservationDefinition) | Element idActivityDefinition.observationRequirementShort description What observations are required to perform this action DefinitionDefines observation requirements for the action to be performed, such as body weight or surface area. Needed to represent observation definitions. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ObservationDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| observationResultRequirement | C | 0..* | Reference(ObservationDefinition) | Element idActivityDefinition.observationResultRequirementShort description What observations must be produced by this action DefinitionDefines the observations that are expected to be produced by the action. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ObservationDefinition) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| transform | 0..1 | canonical(StructureMap) | Element idActivityDefinition.transformShort description Transform to apply the template DefinitionA 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.
| |||
| dynamicValue | 0..* | BackboneElement | Element idActivityDefinition.dynamicValueShort description Dynamic aspects of the definition DefinitionDynamic 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idActivityDefinition.dynamicValue.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idActivityDefinition.dynamicValue.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idActivityDefinition.dynamicValue.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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.
| ||
| path | 1..1 | string | Element idActivityDefinition.dynamicValue.pathShort description The path to the element to be set dynamically DefinitionThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.
| |||
| expression | C | 1..1 | Expression | Element idActivityDefinition.dynamicValue.expressionShort description An expression that provides the dynamic value for the customization DefinitionAn expression specifying the value of the customized element. The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Additional Guidance
- identifier
- title
- status
- experimental
- version
- useContext
- code
- library
- specimenRequirement
- relatedArtifact
identifier
SHALL be present. The DGTS test readable ID assigned to the test."identifier": [ { "system": "http://fhir.nhs.uk/Id/Genomics-DGTS", "value": "GT1" } ],
title
SHALL be present. The DGTS test name."title": "15q11 critical region (AS/PWS) - MLPA or equivalent",
status
SHALL be present. Used to represent the state of a test. Mapping of statuses which do not match the required HL7 ValueSet, e.g. "Deprecated", are pending investigation."status": "active",
experimental
SHALL be present. For representing whether a test/test package is in pre-release."experimental": false,
version
SHALL be present. The DGTS Test version."version": "1.0",
useContext
SHALL be present. Used for capturing the requesting reasons which are eligible for this test/test package"useContext": [ { "code": { "code": "focus", "system": "http://terminology.hl7.org/CodeSystem/usage-context-type" }, "valueCodeableConcept": { "coding": [ { "code": "diagnostic", "system": "https://fhir.nhs.uk/CodeSystem/reasonfortesting-genomics" } ] } } ],
code
SHALL be present. Used to represent the Test Method. Alignment with the HL7 method type list is under investigation."code": { "coding": [ { "code": "targeted-variant-analysis", "system": "http://hl7.org/fhir/genomicstudy-methodtype" } ] },
library
SHALL be present. A link to the data requirements for ordering this test."library": [ "http://fhir.nhs.uk/Library/GT1" ],
specimenRequirement
MAY be present. A reference to the specimen(s) expected for this test."specimenRequirement": [ { "reference": "SpecimenDefinition/DGTS-SpecimenDefinition-Example" } ],
relatedArtifact
MAY be present. Links to the GEL panels which could be included as part of this test (if marked as a GMS Rare Disease Virtual, can be added to the order as an additional panel)."relatedArtifact": [ { "type": "composed-of", "url": "https://panelapp.genomicsengland.co.uk/panels/1313", "label": "Carney complex", "display": "GMS Rare Disease" } ]