Order Catalog Implementation Guide
1.0.0-ballot - CI Build International flag

Order Catalog Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions

Resource Profile: LabProcedureDefinition - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the LabProcedureDefinition resource profile.

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

0. ActivityDefinition
2. ActivityDefinition.url
Control1..?
4. ActivityDefinition.title
Must Supporttrue
6. ActivityDefinition.title.extension
SlicingThis element introduces a set of slices on ActivityDefinition.title.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. ActivityDefinition.title.extension:OtherTitle
    Slice NameOtherTitle
    TypeExtension(Translation) (Complex Extension)
    10. ActivityDefinition.date
    Must Supporttrue
    12. ActivityDefinition.publisher
    Must Supporttrue
    14. ActivityDefinition.contact
    16. ActivityDefinition.contact.telecom
    Must Supporttrue
    18. ActivityDefinition.description
    Definition

    A free text natural language description of the laboratory procedure from a consumer's perspective.

    Must Supporttrue
    20. ActivityDefinition.effectivePeriod
    22. ActivityDefinition.effectivePeriod.start
    Must Supporttrue
    24. ActivityDefinition.effectivePeriod.end
    Must Supporttrue
    26. ActivityDefinition.topic
    ShortCategorization of the laboratory procedure
    Comments

    Examples could be lab specialties: chemistry, hormonology, hematology, bacteriology, virology .. Other examples might list medical specialty of orderer: cardiology, dermatology, gastroenterology ...

    Must Supporttrue
    28. ActivityDefinition.kind
    Control1..?
    Fixed ValueServiceRequest
    30. ActivityDefinition.code
    Must Supporttrue
    32. ActivityDefinition.code.coding
    ShortCode for the laboratory procedure
    SlicingThis element introduces a set of slices on ActivityDefinition.code.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ system
    • 34. ActivityDefinition.code.coding:orderCodeLOINC
      Slice NameorderCodeLOINC
      ShortLOINC code for the laboratory procedure
      Control0..1
      Must Supporttrue
      36. ActivityDefinition.code.coding:orderCodeLOINC.system
      ShortLOINC test code for this activity
      Must Supporttrue
      LabelLOINC
      Fixed Valuehttp://loinc.org
      38. ActivityDefinition.doNotPerform
      Control0..0
      40. ActivityDefinition.location
      Definition

      Identifies the facility where the laboratory procedure will occur, and where the specimens will be conveyed

      ShortThe physical sector of the laboratory performing the procedure
      Comments

      May be tha laboratory as a whole or its work area facility or a sector of it

      42. ActivityDefinition.specimenRequirement
      Definition

      Defines specimen requirements for the laboratory procedure (test or panel) to be performed.

      ShortWhat specimens are required to perform this laboratory procedure
      Typecanonical(Laboratory IVD Specimen Definition)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      44. ActivityDefinition.observationRequirement
      Definition

      Defines observation requirements for the laboratory procedure (test or panel) to be performed, such as body weight or surface area.

      ShortWhat observations are required to perform this laboratory procedure
      Typecanonical(Input Observation)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      46. ActivityDefinition.observationResultRequirement
      Definition

      Defines the observations that are expected to be produced by the laboratory procedure.

      ShortWhat observations are produced by this laboratory procedure
      Typecanonical(Laboratory Observation Definition)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue

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

      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
      Must Supportfalse
      Summaryfalse
      Invariantscnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,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 its narrative along with other profiles, value sets, etc.

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

      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

      ShortContained, inline 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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

      Control0..*
      This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
      TypeResource
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      6. ActivityDefinition.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 managable, 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).

      ShortExtensions 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..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Must Supportfalse
      Summarytrue
      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())
      8. ActivityDefinition.url
      Definition

      An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address 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.

      ShortCanonical identifier for this activity definition, represented as a URI (globally unique)
      Comments

      Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

      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.

      Control10..1
      Typeuri
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Requirements

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

      Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. ActivityDefinition.title
      Definition

      A short, descriptive, user-friendly title for the activity definition.

      ShortName for this activity definition (human friendly)
      Comments

      This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. ActivityDefinition.title.extension
      Definition

      An Extension


      May 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 managable, 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.

      ShortExtensionAdditional content defined by implementations
      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..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      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())
      SlicingThis element introduces a set of slices on ActivityDefinition.title.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 14. ActivityDefinition.title.extension:OtherTitle
        Slice NameOtherTitle
        Definition

        Language translation from base language of resource to another language.

        ShortLanguage Translation (Localization)
        Control0..*
        TypeExtension(Translation) (Complex Extension)
        Is Modifierfalse
        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())
        16. 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.

        See guidance around (not) making local changes to elements here.


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

        See guidance around (not) making local changes to elements here.

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

        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
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        18. ActivityDefinition.date
        Definition

        The date (and optionally time) when the activity definition was last significantly changed. 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.

        ShortDate last changed
        Comments

        The date is often not tracked until the resource is published, but may be present on draft content. 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.

        See guidance around (not) making local changes to elements here.


        The date is often not tracked until the resource is published, but may be present on draft content. 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.

        See guidance around (not) making local changes to elements here.

        Control0..1
        TypedateTime
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Alternate NamesRevision Date
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. ActivityDefinition.publisher
        Definition

        The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition.

        ShortName of the publisher/steward (organization or individual)
        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.

        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Requirements

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

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

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

        ShortContact details for the publisher
        Comments

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

        See guidance around (not) making local changes to elements here.


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

        See guidance around (not) making local changes to elements here.

        Control0..*
        TypeContactDetail
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. ActivityDefinition.contact.telecom
        Definition

        The contact details for the individual (if a name was provided) or the organization.

        ShortContact details for individual or organization
        Control0..*
        TypeContactPoint
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        26. ActivityDefinition.description
        Definition

        A free text natural language description of the laboratory procedure from a consumer's perspective.


        A free text natural language description of the activity definition from a consumer's perspective.

        ShortNatural language description of the activity definition
        Comments

        This description can be used to capture details such as 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).

        Control0..1
        Typemarkdown
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. 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 an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015.

        See guidance around (not) making local changes to elements here.


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

        See guidance around (not) making local changes to elements here.

        Control0..1
        TypePeriod
        Is Modifierfalse
        Must Supportfalse
        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()))
        30. ActivityDefinition.effectivePeriod.start
        Definition

        The start of the period. The boundary is inclusive.

        ShortStarting time with inclusive boundary
        Comments

        If the low element is missing, the meaning is that the low boundary is not known.

        Control0..1
        This element is affected by the following invariants: per-1
        TypedateTime
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. ActivityDefinition.effectivePeriod.end
        Definition

        The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

        ShortEnd time with inclusive boundary, if not ongoing
        Comments

        The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

        Control0..1
        This element is affected by the following invariants: per-1
        TypedateTime
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. 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.

        ShortCategorization of the laboratory procedureE.g. Education, Treatment, Assessment, etc
        Comments

        Examples could be lab specialties: chemistry, hormonology, hematology, bacteriology, virology .. Other examples might list medical specialty of orderer: cardiology, dermatology, gastroenterology ...


        DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

        Control0..*
        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
        Must Supporttrue
        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()))
        36. ActivityDefinition.kind
        Definition

        A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.

        ShortKind of resource
        Comments

        The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created may determine what types of extensions are permitted.

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

        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
        Must Supportfalse
        Summarytrue
        Fixed ValueServiceRequest
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. ActivityDefinition.code
        Definition

        Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

        ShortDetail type of activity
        Comments

        Tends to be less relevant for activities involving particular products.

        Control0..1
        BindingFor example codes, see ProcedureCodesSNOMEDCThttp://hl7.org/fhir/ValueSet/procedure-code
        (example to http://hl7.org/fhir/ValueSet/procedure-code)

        Detailed type of the activity; e.g. CBC.

        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Allows matching performed to planned as well as validation against protocols.

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

        A reference to a code defined by a terminology system.

        ShortCode for the laboratory procedureCode defined by a terminology system
        Comments

        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

        Control0..*
        TypeCoding
        Is Modifierfalse
        Summarytrue
        Requirements

        Allows for alternative encodings within a code system, and translations to other code systems.

        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.code.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ system
        • 42. ActivityDefinition.code.coding:orderCodeLOINC
          Slice NameorderCodeLOINC
          Definition

          A reference to a code defined by a terminology system.

          ShortLOINC code for the laboratory procedureCode defined by a terminology system
          Comments

          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

          Control0..1*
          TypeCoding
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Requirements

          Allows for alternative encodings within a code system, and translations to other code systems.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          44. ActivityDefinition.code.coding:orderCodeLOINC.system
          Definition

          The identification of the code system that defines the meaning of the symbol in the code.

          ShortLOINC test code for this activityIdentity of the terminology system
          Comments

          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

          Control0..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          Need to be unambiguous about the source of the definition of the symbol.

          LabelLOINC
          Fixed Valuehttp://loinc.org
          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 RequestOrchestration.

          Control0..01
          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
          Must Supportfalse
          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 laboratory procedure will occur, and where the specimens will be conveyed


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

          ShortThe physical sector of the laboratory performing the procedureWhere it should happen
          Comments

          May be tha laboratory as a whole or its work area facility or a sector of it


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

          Control0..1
          TypeCodeableReference(Location)
          Is Modifierfalse
          Must Supportfalse
          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.specimenRequirement
          Definition

          Defines specimen requirements for the laboratory procedure (test or panel) to be performed.


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

          ShortWhat specimens are required to perform this laboratory procedureWhat specimens are required to perform this action
          Control0..*
          Typecanonical(Laboratory IVD Specimen Definition, SpecimenDefinition)
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          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()))
          52. ActivityDefinition.observationRequirement
          Definition

          Defines observation requirements for the laboratory procedure (test or panel) to be performed, such as body weight or surface area.


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

          ShortWhat observations are required to perform this laboratory procedureWhat observations are required to perform this action
          Control0..*
          Typecanonical(Input Observation, ObservationDefinition)
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summaryfalse
          Requirements

          Needed to represent observation definitions.

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

          Defines the observations that are expected to be produced by the laboratory procedure.


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

          ShortWhat observations are produced by this laboratory procedureWhat observations must be produced by this action
          Control0..*
          Typecanonical(Laboratory Observation Definition, ObservationDefinition)
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

          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
          Must Supportfalse
          Summaryfalse
          Invariantscnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
          2. ActivityDefinition.id
          Definition

          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

          ShortLogical id of this artifact
          Comments

          Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

          Control0..1
          Typeid
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          4. ActivityDefinition.meta
          Definition

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

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          6. 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 its narrative along with other profiles, value sets, etc.

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

          The base language in which the resource is written.

          ShortLanguage of the resource content
          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).

          Control0..1
          BindingThe codes SHALL be taken from AllLanguages
          (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

          IETF language tag for a human language

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          10. ActivityDefinition.text
          Definition

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

          ShortText summary of the resource, for human interpretation
          Comments

          Contained resources do not have a 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.

          Control0..1
          This element is affected by the following invariants: dom-6
          TypeNarrative
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. ActivityDefinition.contained
          Definition

          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

          ShortContained, inline 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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

          Control0..*
          This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
          TypeResource
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          14. ActivityDefinition.extension
          Definition

          May 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 managable, 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.

          ShortAdditional content defined by implementations
          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..*
          TypeExtension
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          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())
          16. ActivityDefinition.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 managable, 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).

          ShortExtensions 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..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
          Must Supportfalse
          Summarytrue
          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())
          18. ActivityDefinition.url
          Definition

          An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address 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.

          ShortCanonical identifier for this activity definition, represented as a URI (globally unique)
          Comments

          Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

          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.

          Control1..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Requirements

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

          Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
          ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          20. 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)
          Control0..*
          TypeIdentifier
          Is Modifierfalse
          Must Supportfalse
          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()))
          22. ActivityDefinition.version
          Definition

          The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.

          ShortBusiness version of the activity definition
          Comments

          There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the activity definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          24. ActivityDefinition.versionAlgorithm[x]
          Definition

          Indicates the mechanism used to compare versions to determine which is more current.

          ShortHow to compare versions
          Comments

          If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

          Control0..1
          BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithm
          (extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
          TypeChoice of: string, Coding
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          26. 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.

          ShortName for this activity definition (computer friendly)
          Comments

          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.

          Control0..1
          This element is affected by the following invariants: cnl-0
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Requirements

          Support human navigation and code generation.

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

          A short, descriptive, user-friendly title for the activity definition.

          ShortName for this activity definition (human friendly)
          Comments

          This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          30. ActivityDefinition.title.id
          Definition

          unique id for the element within a resource (for internal references)

          Shortxml:id (or equivalent in JSON)
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          32. ActivityDefinition.title.extension
          Definition

          An Extension

          ShortExtension
          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          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())
          SlicingThis element introduces a set of slices on ActivityDefinition.title.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 34. ActivityDefinition.title.extension:OtherTitle
            Slice NameOtherTitle
            Definition

            Language translation from base language of resource to another language.

            ShortLanguage Translation (Localization)
            Control0..*
            TypeExtension(Translation) (Complex Extension)
            Is Modifierfalse
            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())
            36. ActivityDefinition.title.value
            Definition

            The actual value

            ShortPrimitive value for string
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Max Length:1048576
            38. ActivityDefinition.subtitle
            Definition

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

            ShortSubordinate title of the activity definition
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            40. 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.

            See guidance around (not) making local changes to elements here.

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

            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
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            42. ActivityDefinition.experimental
            Definition

            A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

            ShortFor testing purposes, not real usage
            Comments

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

            Control0..1
            Typeboolean
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summarytrue
            Requirements

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

            Meaning if MissingIf absent, this resource is treated as though it is not experimental.
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            44. ActivityDefinition.subject[x]
            Definition

            A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

            ShortType of individual the activity definition is intended for
            Comments

            Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.

            Control0..1
            BindingUnless not suitable, these codes SHALL be taken from ParticipantResourceTypes
            (extensible to http://hl7.org/fhir/ValueSet/participant-resource-types)

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

            TypeChoice of: CodeableConcept, Reference(Group, MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, PackagedProductDefinition), canonical(EvidenceVariable)
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summaryfalse
            Meaning if MissingPatient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            46. ActivityDefinition.date
            Definition

            The date (and optionally time) when the activity definition was last significantly changed. 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.

            ShortDate last changed
            Comments

            The date is often not tracked until the resource is published, but may be present on draft content. 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.

            See guidance around (not) making local changes to elements here.

            Control0..1
            TypedateTime
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Alternate NamesRevision Date
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            48. ActivityDefinition.publisher
            Definition

            The name of the organization or individual responsible for the release and ongoing maintenance of the activity definition.

            ShortName of the publisher/steward (organization or individual)
            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.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Requirements

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

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

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

            ShortContact details for the publisher
            Comments

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

            See guidance around (not) making local changes to elements here.

            Control0..*
            TypeContactDetail
            Is Modifierfalse
            Must Supportfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            52. ActivityDefinition.contact.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            This element is affected by the following invariants: ele-1
            Typeid
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            54. ActivityDefinition.contact.extension
            Definition

            May 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 managable, 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.

            ShortAdditional content defined by implementations
            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..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            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())
            SlicingThis element introduces a set of slices on ActivityDefinition.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 56. ActivityDefinition.contact.name
              Definition

              The name of an individual to contact.

              ShortName of an individual to contact
              Comments

              If there is no named individual, the telecom information is for the organization as a whole.

              Control0..1
              Typestring
              Is Modifierfalse
              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()))
              58. ActivityDefinition.contact.telecom
              Definition

              The contact details for the individual (if a name was provided) or the organization.

              ShortContact details for individual or organization
              Control0..*
              TypeContactPoint
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              60. ActivityDefinition.description
              Definition

              A free text natural language description of the laboratory procedure from a consumer's perspective.

              ShortNatural language description of the activity definition
              Comments

              This description can be used to capture details such as 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).

              Control0..1
              Typemarkdown
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              62. 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..*
              TypeUsageContext
              Is Modifierfalse
              Must Supportfalse
              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()))
              64. ActivityDefinition.jurisdiction
              Definition

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

              ShortIntended jurisdiction for activity definition (if applicable)
              Comments

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

              DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

              Control0..*
              BindingUnless not suitable, these codes SHALL be taken from JurisdictionValueSet
              (extensible to http://hl7.org/fhir/ValueSet/jurisdiction)

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

              TypeCodeableConcept
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              66. ActivityDefinition.purpose
              Definition

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

              ShortWhy this activity definition is defined
              Comments

              This element does not describe the usage of the activity definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition.

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

              A detailed description of how the activity definition is used from a clinical perspective.

              ShortDescribes the clinical usage of the activity definition
              Control0..1
              Typemarkdown
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              70. 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
              Comments

              The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

              Control0..1
              Typemarkdown
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              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()))
              72. ActivityDefinition.copyrightLabel
              Definition

              A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

              ShortCopyright holder and year(s)
              Comments

              The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              Summaryfalse
              Requirements

              Defines the content expected to be rendered in all representations of the artifact.

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

              See guidance around (not) making local changes to elements here.

              Control0..1
              Typedate
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              76. 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 by the publisher
              Comments

              If specified, this date follows the original approval date.

              See guidance around (not) making local changes to elements here.

              Control0..1
              Typedate
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              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()))
              78. 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 an activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a activity intended to be used for the year 2016 might be published in 2015.

              See guidance around (not) making local changes to elements here.

              Control0..1
              TypePeriod
              Is Modifierfalse
              Must Supportfalse
              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()))
              80. ActivityDefinition.effectivePeriod.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              This element is affected by the following invariants: ele-1
              Typeid
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              82. ActivityDefinition.effectivePeriod.extension
              Definition

              May 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 managable, 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.

              ShortAdditional content defined by implementations
              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..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              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())
              SlicingThis element introduces a set of slices on ActivityDefinition.effectivePeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 84. ActivityDefinition.effectivePeriod.start
                Definition

                The start of the period. The boundary is inclusive.

                ShortStarting time with inclusive boundary
                Comments

                If the low element is missing, the meaning is that the low boundary is not known.

                Control0..1
                This element is affected by the following invariants: per-1
                TypedateTime
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                86. ActivityDefinition.effectivePeriod.end
                Definition

                The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                ShortEnd time with inclusive boundary, if not ongoing
                Comments

                The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                Control0..1
                This element is affected by the following invariants: per-1
                TypedateTime
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                88. 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.

                ShortCategorization of the laboratory procedure
                Comments

                Examples could be lab specialties: chemistry, hormonology, hematology, bacteriology, virology .. Other examples might list medical specialty of orderer: cardiology, dermatology, gastroenterology ...

                Control0..*
                BindingFor example codes, see DefinitionTopic
                (example to http://hl7.org/fhir/ValueSet/definition-topic)

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

                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                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()))
                90. ActivityDefinition.author
                Definition

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

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

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

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

                An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

                ShortWho reviewed the content
                Comments

                See guidance around (not) making local changes to elements here.

                Control0..*
                TypeContactDetail
                Is Modifierfalse
                Must Supportfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                96. ActivityDefinition.endorser
                Definition

                An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

                ShortWho endorsed the content
                Comments

                See guidance around (not) making local changes to elements here.

                Control0..*
                TypeContactDetail
                Is Modifierfalse
                Must Supportfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                98. 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..*
                TypeRelatedArtifact
                Is Modifierfalse
                Must Supportfalse
                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()))
                100. 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..*
                Typecanonical(Library)
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supportfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                102. ActivityDefinition.kind
                Definition

                A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.

                ShortKind of resource
                Comments

                The kind element may only specify Request resource types to facilitate considering user input as part of processing the result of any automated clinical reasoning processes. To support creation of event resources, such as Observations, RiskAssessments, and DetectedIssues, use a Task resource with the focus of the task set to the event resource to be created. Note that the kind of resource to be created may determine what types of extensions are permitted.

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

                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
                Must Supportfalse
                Summarytrue
                Fixed ValueServiceRequest
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                104. 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..1
                Typecanonical(StructureDefinition)
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supportfalse
                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()))
                106. ActivityDefinition.code
                Definition

                Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

                ShortDetail type of activity
                Comments

                Tends to be less relevant for activities involving particular products.

                Control0..1
                BindingFor example codes, see ProcedureCodesSNOMEDCT
                (example to http://hl7.org/fhir/ValueSet/procedure-code)

                Detailed type of the activity; e.g. CBC.

                TypeCodeableConcept
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

                Allows matching performed to planned as well as validation against protocols.

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

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                This element is affected by the following invariants: ele-1
                Typeid
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                110. ActivityDefinition.code.extension
                Definition

                May 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 managable, 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.

                ShortAdditional content defined by implementations
                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..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                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())
                SlicingThis element introduces a set of slices on ActivityDefinition.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 112. ActivityDefinition.code.coding
                  Definition

                  A reference to a code defined by a terminology system.

                  ShortCode for the laboratory procedure
                  Comments

                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                  Control0..*
                  TypeCoding
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Allows for alternative encodings within a code system, and translations to other code systems.

                  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.code.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ system
                  • 114. ActivityDefinition.code.coding:orderCodeLOINC
                    Slice NameorderCodeLOINC
                    Definition

                    A reference to a code defined by a terminology system.

                    ShortLOINC code for the laboratory procedure
                    Comments

                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                    Control0..1
                    TypeCoding
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    Allows for alternative encodings within a code system, and translations to other code systems.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    116. ActivityDefinition.code.coding:orderCodeLOINC.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    This element is affected by the following invariants: ele-1
                    Typeid
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    118. ActivityDefinition.code.coding:orderCodeLOINC.extension
                    Definition

                    May 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 managable, 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.

                    ShortAdditional content defined by implementations
                    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..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    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())
                    SlicingThis element introduces a set of slices on ActivityDefinition.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 120. ActivityDefinition.code.coding:orderCodeLOINC.system
                      Definition

                      The identification of the code system that defines the meaning of the symbol in the code.

                      ShortLOINC test code for this activity
                      Comments

                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

                      Control0..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Need to be unambiguous about the source of the definition of the symbol.

                      LabelLOINC
                      Fixed Valuehttp://loinc.org
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      122. ActivityDefinition.code.coding:orderCodeLOINC.version
                      Definition

                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                      ShortVersion of the system - if relevant
                      Comments

                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                      NoteThis is a business version Id, not a resource version Id (see discussion)
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      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()))
                      124. ActivityDefinition.code.coding:orderCodeLOINC.code
                      Definition

                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                      ShortSymbol in syntax defined by the system
                      Control0..1
                      This element is affected by the following invariants: cod-1
                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to refer to a particular code in the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      126. ActivityDefinition.code.coding:orderCodeLOINC.display
                      Definition

                      A representation of the meaning of the code in the system, following the rules of the system.

                      ShortRepresentation defined by the system
                      Control0..1
                      This element is affected by the following invariants: cod-1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      128. ActivityDefinition.code.coding:orderCodeLOINC.userSelected
                      Definition

                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                      ShortIf this coding was chosen directly by the user
                      Comments

                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                      Control0..1
                      Typeboolean
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                      ShortPlain text representation of the concept
                      Comments

                      Very often the text is the same as a displayName of one of the codings.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

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

                      Shortproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
                      Control0..1
                      BindingThe codes SHALL be taken from RequestIntent
                      (required to http://hl7.org/fhir/ValueSet/request-intent|5.0.0)

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

                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      134. ActivityDefinition.priority
                      Definition

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

                      Shortroutine | urgent | asap | stat
                      Control0..1
                      BindingThe codes SHALL be taken from RequestPriority
                      (required to http://hl7.org/fhir/ValueSet/request-priority|5.0.0)

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

                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      136. 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 RequestOrchestration.

                      Control0..0
                      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
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      138. ActivityDefinition.timing[x]
                      Definition

                      The timing or frequency upon which the described activity is to occur.

                      ShortWhen activity is to occur
                      Comments

                      The intent of the timing element is to provide timing when the action should be performed. As a definitional resource, this timing is interpreted as part of an apply operation so that the timing of the result actions in a CarePlan or RequestOrchestration, for example, would be specified by evaluating the timing definition in the context of the apply and setting the resulting timing on the appropriate elements of the target resource. If the timing is an Age, the activity is expected to be performed when the subject is the given Age. When the timing is a Duration, the activity is expected to be performed within the specified duration from the apply. When the timing is a Range, it may be a range of Ages or Durations, providing a range for the expected timing of the resulting activity. When the timing is a Timing, it is establishing a schedule for the timing of the resulting activity.

                      Control0..1
                      TypeChoice of: Timing, Age, Range, Duration
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Requirements

                      Allows prompting for activities and detection of missed planned activities.

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

                      If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.

                      ShortPreconditions for service
                      Control0..1
                      BindingFor example codes, see SNOMEDCTMedicationAsNeededReasonCodes
                      (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason)

                      A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

                      TypeChoice of: boolean, CodeableConcept
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      142. ActivityDefinition.location
                      Definition

                      Identifies the facility where the laboratory procedure will occur, and where the specimens will be conveyed

                      ShortThe physical sector of the laboratory performing the procedure
                      Comments

                      May be tha laboratory as a whole or its work area facility or a sector of it

                      Control0..1
                      TypeCodeableReference(Location)
                      Is Modifierfalse
                      Must Supportfalse
                      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()))
                      144. ActivityDefinition.participant
                      Definition

                      Indicates who should participate in performing the action described.

                      ShortWho should participate in the action
                      Control0..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      146. 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.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      148. ActivityDefinition.participant.extension
                      Definition

                      May 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 managable, 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.

                      ShortAdditional content defined by implementations
                      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..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      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())
                      150. 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 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 managable, 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).

                      ShortExtensions that cannot be ignored even if unrecognized
                      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..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      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, modifiers
                      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())
                      152. ActivityDefinition.participant.type
                      Definition

                      The type of participant in the action.

                      Shortcareteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson
                      Control0..1
                      BindingThe codes SHALL be taken from ActionParticipantType
                      (required to http://hl7.org/fhir/ValueSet/action-participant-type|5.0.0)

                      The type of participant in the activity.

                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      154. ActivityDefinition.participant.typeCanonical
                      Definition

                      The type of participant in the action.

                      ShortWho or what can participate
                      Control0..1
                      Typecanonical(CapabilityStatement)
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      156. ActivityDefinition.participant.typeReference
                      Definition

                      The type of participant in the action.

                      ShortWho or what can participate
                      Comments

                      When this element is a reference, it SHOULD be a reference to a definitional resource (for example, a location type, rather than a specific location).

                      Control0..1
                      TypeReference(CareTeam, Device, DeviceDefinition, Endpoint, Group, HealthcareService, Location, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      158. ActivityDefinition.participant.role
                      Definition

                      The role the participant should play in performing the described action.

                      ShortE.g. Nurse, Surgeon, Parent, etc
                      Control0..1
                      BindingFor example codes, see Action Participant Role
                      (example to http://terminology.hl7.org/ValueSet/action-participant-role)

                      Defines roles played by participants for the action.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      160. ActivityDefinition.participant.function
                      Definition

                      Indicates how the actor will be involved in the action - author, reviewer, witness, etc.

                      ShortE.g. Author, Reviewer, Witness, etc
                      Control0..1
                      BindingFor example codes, see ActionParticipantFunction
                      (example to http://hl7.org/fhir/ValueSet/action-participant-function)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      162. ActivityDefinition.product[x]
                      Definition

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

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

                      Code describing the type of substance or medication.

                      TypeChoice of: Reference(Medication, Ingredient, Substance, SubstanceDefinition), CodeableConcept
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      164. ActivityDefinition.quantity
                      Definition

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

                      ShortHow much is administered/consumed/supplied
                      Control0..1
                      TypeQuantity(SimpleQuantity)
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Alternate Namesdose
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      166. 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..*
                      TypeDosage
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      168. 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..*
                      BindingFor example codes, see SNOMEDCTBodyStructures
                      (example to http://hl7.org/fhir/ValueSet/body-site)

                      A code that identifies the anatomical location.

                      TypeCodeableConcept
                      Is Modifierfalse
                      Must Supportfalse
                      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()))
                      170. ActivityDefinition.specimenRequirement
                      Definition

                      Defines specimen requirements for the laboratory procedure (test or panel) to be performed.

                      ShortWhat specimens are required to perform this laboratory procedure
                      Control0..*
                      Typecanonical(Laboratory IVD Specimen Definition)
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      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()))
                      172. ActivityDefinition.observationRequirement
                      Definition

                      Defines observation requirements for the laboratory procedure (test or panel) to be performed, such as body weight or surface area.

                      ShortWhat observations are required to perform this laboratory procedure
                      Control0..*
                      Typecanonical(Input Observation)
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summaryfalse
                      Requirements

                      Needed to represent observation definitions.

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

                      Defines the observations that are expected to be produced by the laboratory procedure.

                      ShortWhat observations are produced by this laboratory procedure
                      Control0..*
                      Typecanonical(Laboratory Observation Definition)
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      176. 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..1
                      Typecanonical(StructureMap)
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      178. 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..*
                      TypeBackboneElement
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      180. 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.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      This element is affected by the following invariants: ele-1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      182. ActivityDefinition.dynamicValue.extension
                      Definition

                      May 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 managable, 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.

                      ShortAdditional content defined by implementations
                      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..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      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())
                      184. 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 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 managable, 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).

                      ShortExtensions that cannot be ignored even if unrecognized
                      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..*
                      TypeExtension
                      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                      Summarytrue
                      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, modifiers
                      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())
                      186. 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. The specified path SHALL be a FHIRPath resolvable 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).

                      ShortThe path to the element to be set dynamically
                      Comments

                      The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

                      Control1..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      188. ActivityDefinition.dynamicValue.expression
                      Definition

                      An expression specifying the value of the customized element.

                      ShortAn expression that provides the dynamic value for the customization
                      Comments

                      The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.

                      Control1..1
                      TypeExpression
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))