Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-ActivityDefinition | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_ActivityDefinition_R3 | ||
This cross-version profile allows R5 ActivityDefinition content to be represented via FHIR STU3 ActivityDefinition resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| ActivityDefinition.status | Base | required | PublicationStatus | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | ActivityDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ActivityDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  ActivityDefinition |
0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | |||||
  id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages  (extensible): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
   extension:versionAlgorithm |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm | |||||
| extension:subtitle |
0..1 | string | R5: Subordinate title of the activity definition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.subtitle | |||||
| extension:subject |
0..1 | CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3(0.1.0) | Group | Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3(0.1.0) | Basic), uri | R5: Type of individual the activity definition is intended for (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.subject Binding: R5ParticipantResourceTypesForR3 (0.1.0) (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). | |||||
| extension:copyrightLabel |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |||||
| extension:profile |
0..1 | uri | R5: What profile the resource needs to conform to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.profile | |||||
| extension:intent |
0..1 | code | R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.intent Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. | |||||
| extension:priority |
0..1 | code | R5: routine | urgent | asap | stat (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.priority Binding: MedicationRequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| extension:timing |
0..1 | Age, Duration | R5: timing additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.timing | |||||
| extension:asNeeded |
0..1 | boolean, CodeableConcept | R5: Preconditions for service (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.asNeeded | |||||
| extension:specimenRequirement |
0..* | uri | R5: What specimens are required to perform this action (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.specimenRequirement | |||||
| extension:observationRequirement |
0..* | uri | R5: What observations are required to perform this action (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.observationRequirement | |||||
 extension:observationResultRequirement |
0..* | uri | R5: What observations must be produced by this action (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.observationResultRequirement | |||||
 Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension:doNotPerform |
?! | 0..1 | boolean | R5: True if the activity should not be performed (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.doNotPerform | ||||
| url |
Σ | 0..1 | uri | Logical URI to reference this activity definition (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the activity definition | ||||
| version |
Σ | 0..1 | string | Business version of the activity definition | ||||
| name |
Σ | 0..1 | string | Name for this activity definition (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this activity definition (human friendly) | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map. | ||||
| experimental |
?!Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date this was last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the activity definition | ||||
| purpose |
0..1 | markdown | Why this activity definition is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the asset | |||||
| approvalDate |
0..1 | date | When the activity definition was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the activity definition was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the activity definition is expected to be used | ||||
| useContext |
Σ | 0..* | UsageContext | Context the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering | |||||
| contributor |
0..* | Contributor | A content contributor | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:author |
0..* | (Complex) | R5: Who authored the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.author | |||||
| extension:editor |
0..* | (Complex) | R5: Who edited the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.editor | |||||
| extension:reviewer |
0..* | (Complex) | R5: Who reviewed the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.reviewer | |||||
| extension:endorser |
0..* | (Complex) | R5: Who endorsed the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.endorser | |||||
| type |
Σ | 1..1 | code | author | editor | reviewer | endorser Binding: ContributorType (required): The type of contributor | ||||
| name |
Σ | 1..1 | string | Who contributed the content | ||||
 contact |
Σ | 0..* | ContactDetail | Contact details of the contributor | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:contact |
0..* | (Complex) | R5: contact additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.contact | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
 library |
0..* | Reference(Library) | Logic used by the asset | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:library |
0..* | uri | R5: Logic used by the activity definition additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.library | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| kind |
0..1 | code | Kind of resource Binding: ResourceType (required): The kind of activity the definition is describing | |||||
| code |
0..1 | CodeableConcept | Detail type of activity Binding: Procedure Codes (SNOMED CT) (example): Detailed type of the activity; e.g. CBC | |||||
 timing[x] |
0..1 | When activity is to occur | ||||||
| timingTiming |
Timing | |||||||
| timingDateTime |
dateTime | |||||||
| timingPeriod |
Period | |||||||
| timingRange |
Range | |||||||
| location |
0..1 | Reference(Location) | Where it should happen | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:location |
0..1 | CodeableConcept | R5: location additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.location | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| participant |
0..* | BackboneElement | Who should participate in the action | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:typeCanonical |
0..1 | uri | R5: Who or what can participate (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.typeCanonical | |||||
| extension:typeReference |
0..1 | Reference(Cross-version Profile for R5.CareTeam for use in FHIR STU3(0.1.0) | CareTeam | Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R5.DeviceDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.Endpoint for use in FHIR STU3(0.1.0) | Endpoint | Cross-version Profile for R5.Group for use in FHIR STU3(0.1.0) | Group | Cross-version Profile for R5.HealthcareService for use in FHIR STU3(0.1.0) | HealthcareService | Cross-version Profile for R5.Location for use in FHIR STU3(0.1.0) | Location | Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R5.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson) | R5: Who or what can participate (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.typeReference | |||||
| extension:function |
0..1 | CodeableConcept | R5: E.g. Author, Reviewer, Witness, etc (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.function Binding: R5ActionParticipantFunctionForR3 (0.1.0) (example) | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
1..1 | code | patient | practitioner | related-person Binding: ActionParticipantType (required): The type of participant in the activity | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..1 | code | R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.type Binding: R5ActionParticipantTypeForR3 (0.1.0) (required): The type of participant in the activity. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| role |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc Binding: ActionParticipantRole (example): Defines roles played by participants for the action | |||||
| product[x] |
0..1 | What's administered/supplied Binding: SNOMED CT Medication Codes (example): Code describing the type of substance or medication | ||||||
 product[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
 extension:alternateReference |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: product URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| productReference |
Reference(Medication | Substance) | |||||||
| productCodeableConcept |
CodeableConcept | |||||||
| quantity |
0..1 | SimpleQuantity | How much is administered/consumed/supplied | |||||
| dosage |
0..* | Dosage | Detailed dosage instructions | |||||
| bodySite |
0..* | CodeableConcept | What part of body to perform on Binding: SNOMED CT Body Structures (example): A code that identifies the anatomical location | |||||
| transform |
0..1 | Reference(StructureMap) | Transform to apply the template | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:transform |
0..1 | uri | R5: transform additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.transform | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
 dynamicValue |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| description |
0..1 | string | Natural language description of the dynamic value | |||||
| path |
0..1 | string | The path to the element to be set dynamically | |||||
| language |
0..1 | string | Language of the expression | |||||
| expression |
0..1 | string | An expression that provides the dynamic value for the customization | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ActivityDefinition.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| ActivityDefinition.status | Base | required | PublicationStatus | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.topic | Base | example | DefinitionTopic | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.contributor.type | Base | required | ContributorType | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.kind | Base | required |
ResourceType
|
📍3.0.2 | tx.fhir.org |
| ActivityDefinition.code | Base | example | Procedure Codes (SNOMED CT) | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.participant.type | Base | required |
ActionParticipantType
|
📍3.0.2 | tx.fhir.org |
| ActivityDefinition.participant.role | Base | example | ActionParticipantRole | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.product[x] | Base | example | SNOMED CT Medication Codes | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.bodySite | Base | example | SNOMED CT Body Structures | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | ActivityDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ActivityDefinition
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| ActivityDefinition.status | Base | required | PublicationStatus | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | ActivityDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from ActivityDefinition
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ActivityDefinition |
0..* | ActivityDefinition | The definition of a specific activity to be taken, independent of any particular patient or context | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:versionAlgorithm |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm | |||||
| extension:subtitle |
0..1 | string | R5: Subordinate title of the activity definition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.subtitle | |||||
| extension:subject |
0..1 | CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR STU3(0.1.0) | Group | Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.SubstanceDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.AdministrableProductDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.ManufacturedItemDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.PackagedProductDefinition for use in FHIR STU3(0.1.0) | Basic), uri | R5: Type of individual the activity definition is intended for (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.subject Binding: R5ParticipantResourceTypesForR3 (0.1.0) (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). | |||||
| extension:copyrightLabel |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | |||||
| extension:profile |
0..1 | uri | R5: What profile the resource needs to conform to (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.profile | |||||
| extension:intent |
0..1 | code | R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.intent Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. | |||||
| extension:priority |
0..1 | code | R5: routine | urgent | asap | stat (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.priority Binding: MedicationRequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| extension:timing |
0..1 | Age, Duration | R5: timing additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.timing | |||||
| extension:asNeeded |
0..1 | boolean, CodeableConcept | R5: Preconditions for service (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.asNeeded | |||||
| extension:specimenRequirement |
0..* | uri | R5: What specimens are required to perform this action (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.specimenRequirement | |||||
| extension:observationRequirement |
0..* | uri | R5: What observations are required to perform this action (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.observationRequirement | |||||
| extension:observationResultRequirement |
0..* | uri | R5: What observations must be produced by this action (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.observationResultRequirement | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension:doNotPerform |
?! | 0..1 | boolean | R5: True if the activity should not be performed (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.doNotPerform | ||||
| url |
Σ | 0..1 | uri | Logical URI to reference this activity definition (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the activity definition | ||||
| version |
Σ | 0..1 | string | Business version of the activity definition | ||||
| name |
Σ | 0..1 | string | Name for this activity definition (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this activity definition (human friendly) | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map. | ||||
| experimental |
?!Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 0..1 | dateTime | Date this was last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the activity definition | ||||
| purpose |
0..1 | markdown | Why this activity definition is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the asset | |||||
| approvalDate |
0..1 | date | When the activity definition was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the activity definition was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the activity definition is expected to be used | ||||
| useContext |
Σ | 0..* | UsageContext | Context the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering | |||||
| contributor |
0..* | Contributor | A content contributor | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:author |
0..* | (Complex) | R5: Who authored the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.author | |||||
| extension:editor |
0..* | (Complex) | R5: Who edited the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.editor | |||||
| extension:reviewer |
0..* | (Complex) | R5: Who reviewed the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.reviewer | |||||
| extension:endorser |
0..* | (Complex) | R5: Who endorsed the content additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.endorser | |||||
| type |
Σ | 1..1 | code | author | editor | reviewer | endorser Binding: ContributorType (required): The type of contributor | ||||
| name |
Σ | 1..1 | string | Who contributed the content | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details of the contributor | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:contact |
0..* | (Complex) | R5: contact additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.contact | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
| library |
0..* | Reference(Library) | Logic used by the asset | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:library |
0..* | uri | R5: Logic used by the activity definition additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.library | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| kind |
0..1 | code | Kind of resource Binding: ResourceType (required): The kind of activity the definition is describing | |||||
| code |
0..1 | CodeableConcept | Detail type of activity Binding: Procedure Codes (SNOMED CT) (example): Detailed type of the activity; e.g. CBC | |||||
| timing[x] |
0..1 | When activity is to occur | ||||||
| timingTiming |
Timing | |||||||
| timingDateTime |
dateTime | |||||||
| timingPeriod |
Period | |||||||
| timingRange |
Range | |||||||
| location |
0..1 | Reference(Location) | Where it should happen | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:location |
0..1 | CodeableConcept | R5: location additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.location | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| participant |
0..* | BackboneElement | Who should participate in the action | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:typeCanonical |
0..1 | uri | R5: Who or what can participate (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.typeCanonical | |||||
| extension:typeReference |
0..1 | Reference(Cross-version Profile for R5.CareTeam for use in FHIR STU3(0.1.0) | CareTeam | Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R5.DeviceDefinition for use in FHIR STU3(0.1.0) | Basic | Cross-version Profile for R5.Endpoint for use in FHIR STU3(0.1.0) | Endpoint | Cross-version Profile for R5.Group for use in FHIR STU3(0.1.0) | Group | Cross-version Profile for R5.HealthcareService for use in FHIR STU3(0.1.0) | HealthcareService | Cross-version Profile for R5.Location for use in FHIR STU3(0.1.0) | Location | Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R5.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson) | R5: Who or what can participate (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.typeReference | |||||
| extension:function |
0..1 | CodeableConcept | R5: E.g. Author, Reviewer, Witness, etc (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.function Binding: R5ActionParticipantFunctionForR3 (0.1.0) (example) | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
1..1 | code | patient | practitioner | related-person Binding: ActionParticipantType (required): The type of participant in the activity | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..1 | code | R5: careteam | device | group | healthcareservice | location | organization | patient | practitioner | practitionerrole | relatedperson URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.participant.type Binding: R5ActionParticipantTypeForR3 (0.1.0) (required): The type of participant in the activity. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| role |
0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc Binding: ActionParticipantRole (example): Defines roles played by participants for the action | |||||
| product[x] |
0..1 | What's administered/supplied Binding: SNOMED CT Medication Codes (example): Code describing the type of substance or medication | ||||||
| product[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:alternateReference |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: product URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| productReference |
Reference(Medication | Substance) | |||||||
| productCodeableConcept |
CodeableConcept | |||||||
| quantity |
0..1 | SimpleQuantity | How much is administered/consumed/supplied | |||||
| dosage |
0..* | Dosage | Detailed dosage instructions | |||||
| bodySite |
0..* | CodeableConcept | What part of body to perform on Binding: SNOMED CT Body Structures (example): A code that identifies the anatomical location | |||||
| transform |
0..1 | Reference(StructureMap) | Transform to apply the template | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:transform |
0..1 | uri | R5: transform additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ActivityDefinition.transform | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| dynamicValue |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| description |
0..1 | string | Natural language description of the dynamic value | |||||
| path |
0..1 | string | The path to the element to be set dynamically | |||||
| language |
0..1 | string | Language of the expression | |||||
| expression |
0..1 | string | An expression that provides the dynamic value for the customization | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ActivityDefinition.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| ActivityDefinition.status | Base | required | PublicationStatus | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.topic | Base | example | DefinitionTopic | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.contributor.type | Base | required | ContributorType | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.kind | Base | required |
ResourceType
|
📍3.0.2 | tx.fhir.org |
| ActivityDefinition.code | Base | example | Procedure Codes (SNOMED CT) | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.participant.type | Base | required |
ActionParticipantType
|
📍3.0.2 | tx.fhir.org |
| ActivityDefinition.participant.role | Base | example | ActionParticipantRole | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.product[x] | Base | example | SNOMED CT Medication Codes | 📍3.0.2 | FHIR Std. |
| ActivityDefinition.bodySite | Base | example | SNOMED CT Body Structures | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ActivityDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | ActivityDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ActivityDefinition
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change