Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ServiceRequestActivityDefinition - Detailed Descriptions

Active as of 2025-04-11

Definitions for the ServiceRequestActivityDefinition resource profile.

Guidance on how to interpret the contents of this table can be found here

0. ActivityDefinition
Definition

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

ShortThe definition of a specific activity to be taken, independent of any particular patient or context
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsadf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
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 or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
2. ActivityDefinition.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..01
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ActivityDefinition.modifierExtension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensionExtensions that cannot be ignored
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.

Control0..0*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. 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.

ShortAdditional identifier for the activity definition
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
TypeIdentifier
Is Modifierfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. ActivityDefinition.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control10..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Pattern Valueusual
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. ActivityDefinition.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ActivityDefinition.status
Definition

The status of this activity definition. Enables tracking the life-cycle of the content.

Shortdraft | active | retired | unknown
Comments

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

Control1..1
BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

The lifecycle status of an artifact.

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. ActivityDefinition.subject[x]
Definition

A code or group definition that describes the intended subject of the activity being defined.

ShortType of individual the activity definition is intended for
Control0..1
BindingUnless not suitable, these codes SHALL be taken from SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type
(extensible to http://hl7.org/fhir/ValueSet/subject-type)

The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Meaning if MissingPatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ActivityDefinition.subject[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
  • 16. ActivityDefinition.subject[x]:subjectCodeableConcept
    Slice NamesubjectCodeableConcept
    Definition

    A code or group definition that describes the intended subject of the activity being defined.

    ShortType of individual the activity definition is intended for
    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from SubjectTypehttp://hl7.org/fhir/ValueSet/subject-type
    (extensible to http://hl7.org/fhir/ValueSet/subject-type)

    The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

    TypeCodeableConcept, Reference(Group)
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summaryfalse
    Meaning if MissingPatient
    Pattern Value{
      "coding" : [{
        "system" : "http://hl7.org/fhir/resource-types",
        "code" : "Patient"
      }]
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. ActivityDefinition.useContext
    Definition

    The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.

    ShortThe context that the content is intended to support
    Comments

    When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

    Control0..0*
    TypeUsageContext
    Is Modifierfalse
    Summarytrue
    Requirements

    Assist in searching for appropriate content.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. 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.

    ShortUse and/or publishing restrictions
    Control0..01
    Typemarkdown
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Requirements

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

    Alternate NamesLicense, Restrictions
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. ActivityDefinition.approvalDate
    Definition

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

    ShortWhen the activity definition was approved by publisher
    Comments

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

    Control0..01
    Typedate
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. ActivityDefinition.lastReviewDate
    Definition

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

    ShortWhen the activity definition was last reviewed
    Comments

    If specified, this date follows the original approval date.

    Control0..01
    Typedate
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Requirements

    Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. ActivityDefinition.effectivePeriod
    Definition

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

    ShortWhen the activity definition is expected to be used
    Comments

    The effective period for a activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

    Control0..01
    TypePeriod
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the activity definition are or are expected to be used instead.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. 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.

    ShortE.g. Education, Treatment, Assessment, etc.
    Control0..0*
    BindingFor example codes, see DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic
    (example to http://hl7.org/fhir/ValueSet/definition-topic)

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

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. ActivityDefinition.author
    Definition

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

    ShortWho authored the content
    Control0..0*
    TypeContactDetail
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. ActivityDefinition.editor
    Definition

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

    ShortWho edited the content
    Control0..0*
    TypeContactDetail
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. ActivityDefinition.reviewer
    Definition

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

    ShortWho reviewed the content
    Control0..0*
    TypeContactDetail
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. ActivityDefinition.endorser
    Definition

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

    ShortWho endorsed the content
    Control0..0*
    TypeContactDetail
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. ActivityDefinition.relatedArtifact
    Definition

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

    ShortAdditional documentation, citations, etc.
    Comments

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

    Control0..0*
    TypeRelatedArtifact
    Is Modifierfalse
    Summaryfalse
    Requirements

    Activity definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. ActivityDefinition.library
    Definition

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

    ShortLogic used by the activity definition
    Control0..0*
    Typecanonical(Library)
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. ActivityDefinition.kind
    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.

    ShortKind of resource
    Comments

    May determine what types of extensions are permitted.

    Control10..1
    BindingThe codes SHALL be taken from RequestResourceTypehttp://hl7.org/fhir/ValueSet/request-resource-types|4.0.1
    (required to http://hl7.org/fhir/ValueSet/request-resource-types|4.0.1)

    The kind of activity the definition is describing.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Pattern ValueServiceRequest
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. ActivityDefinition.profile
    Definition

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

    ShortWhat profile the resource needs to conform to
    Control0..01
    Typecanonical(StructureDefinition)
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. ActivityDefinition.doNotPerform
    Definition

    Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.

    ShortTrue if the activity should not be performed
    Comments

    This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestGroup.

    Control0..1
    Typeboolean
    Is Modifiertrue because If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. ActivityDefinition.location
    Definition

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

    ShortWhere it should happen
    Comments

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

    Control0..01
    TypeReference(Location)
    Is Modifierfalse
    Summaryfalse
    Requirements

    Helps in planning of activity.

    Alternate Namesfacility
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. ActivityDefinition.product[x]
    Definition

    Identifies the food, drug or other product being consumed or supplied in the activity.

    ShortWhat's administered/supplied
    Control0..01
    BindingFor example codes, see SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes
    (example to http://hl7.org/fhir/ValueSet/medication-codes)

    Code describing the type of substance or medication.

    TypeChoice of: Reference(Medication, Substance), CodeableConcept
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. ActivityDefinition.quantity
    Definition

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

    ShortHow much is administered/consumed/supplied
    Control0..01
    TypeQuantity(SimpleQuantity)
    Is Modifierfalse
    Summaryfalse
    Alternate Namesdose
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    54. ActivityDefinition.dosage
    Definition

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

    ShortDetailed dosage instructions
    Comments

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

    Control0..0*
    TypeDosage
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    56. ActivityDefinition.bodySite
    Definition

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

    ShortWhat part of body to perform on
    Comments

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

    Control0..0*
    BindingFor example codes, see SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site
    (example to http://hl7.org/fhir/ValueSet/body-site)

    A code that identifies the anatomical location.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. ActivityDefinition.specimenRequirement
    Definition

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

    ShortWhat specimens are required to perform this action
    Control0..0*
    TypeReference(SpecimenDefinition)
    Is Modifierfalse
    Summaryfalse
    Requirements

    Needed to represent lab order definitions.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    60. ActivityDefinition.observationRequirement
    Definition

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

    ShortWhat observations are required to perform this action
    Control0..0*
    TypeReference(ObservationDefinition)
    Is Modifierfalse
    Summaryfalse
    Requirements

    Needed to represent observation definitions.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    62. ActivityDefinition.observationResultRequirement
    Definition

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

    ShortWhat observations must be produced by this action
    Control0..0*
    TypeReference(ObservationDefinition)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    64. 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.

    ShortTransform to apply the template
    Comments

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

    Control0..01
    Typecanonical(StructureMap)
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    66. ActivityDefinition.dynamicValue
    Definition

    Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.

    ShortDynamic aspects of the definition
    Comments

    Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.

    Control0..0*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))