Extensions for Using Data Elements from FHIR STU3 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-ActivityDefinition | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R3_ActivityDefinition_R4 | ||
This cross-version profile allows STU3 ActivityDefinition content to be represented via FHIR R4 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.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ActivityDefinition |
C | 0..* | ActivityDefinition(4.0.1) | The definition of a specific activity to be taken, independent of any particular patient or context Constraints: adf-0 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
   extension:contributor |
0..* | Contributor | STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.contributor Constraints: ext-1 | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
 doNotPerform |
?!Σ | 0..1 | boolean | True if the activity should not be performed |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ActivityDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| adf-0 | warning | ActivityDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | 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()
|
| dom-5 | error | ActivityDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ActivityDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ActivityDefinition.implicitRules, ActivityDefinition.extension, ActivityDefinition.extension:contributor, ActivityDefinition.modifierExtension, ActivityDefinition.status, ActivityDefinition.doNotPerform | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ActivityDefinition.extension, ActivityDefinition.extension:contributor, ActivityDefinition.modifierExtension | 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 |
C | 0..* | ActivityDefinition(4.0.1) | The definition of a specific activity to be taken, independent of any particular patient or context Constraints: adf-0 | ||||
| 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: CommonLanguages (preferred): 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 Constraints: ext-1 | |||||
| extension:contributor |
0..* | Contributor | STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.contributor Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the activity definition | ||||
| version |
Σ | 0..1 | string | Business version of the activity definition | ||||
| name |
ΣC | 0..1 | string | Name for this activity definition (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this activity definition (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the activity definition | |||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
 subject[x] |
0..1 | Type of individual the activity definition is intended for Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept |
CodeableConcept | |||||||
 subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the activity definition | ||||
| useContext |
Σ | 0..* | UsageContext | The context that 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. | ||||
| purpose |
0..1 | markdown | Why this activity definition is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the activity definition | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| 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 | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
| library |
0..* | canonical(Library) | Logic used by the activity definition | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:library |
0..* | Reference(Cross-version Profile for STU3.Library for use in FHIR R4(0.1.0) | Library) | STU3: Logic used by the asset additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.library Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| kind |
Σ | 0..1 | code | Kind of resource Binding: RequestResourceType (required): The kind of activity the definition is describing. | ||||
| profile |
0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to | |||||
| code |
Σ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC. | ||||
| intent |
0..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if the activity should not be performed | ||||
| timing[x] |
0..1 | When activity is to occur | ||||||
| timingTiming |
Timing | |||||||
| timingDateTime |
dateTime | |||||||
| timingAge |
Age | |||||||
| timingPeriod |
Period | |||||||
| timingRange |
Range | |||||||
| timingDuration |
Duration | |||||||
| location |
0..1 | Reference(Location) | Where it should happen | |||||
| participant |
0..* | BackboneElement | Who should participate in the action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| type |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant in the activity. | |||||
| 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: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication. | ||||||
| productReference |
Reference(Medication | Substance) | |||||||
| productCodeableConcept |
CodeableConcept | |||||||
| quantity |
0..1 | SimpleQuantity(4.0.1) | How much is administered/consumed/supplied | |||||
| dosage |
0..* | Dosage | Detailed dosage instructions | |||||
| bodySite |
0..* | CodeableConcept | What part of body to perform on Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location. | |||||
| specimenRequirement |
0..* | Reference(SpecimenDefinition) | What specimens are required to perform this action | |||||
| observationRequirement |
0..* | Reference(ObservationDefinition) | What observations are required to perform this action | |||||
| observationResultRequirement |
0..* | Reference(ObservationDefinition) | What observations must be produced by this action | |||||
| transform |
0..1 | canonical(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 Constraints: ext-1 | |||||
| extension:transform |
0..1 | Reference(Cross-version Profile for STU3.StructureMap for use in FHIR R4(0.1.0) | StructureMap) | STU3: transform additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.transform Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
 dynamicValue |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| path |
1..1 | string | The path to the element to be set dynamically | |||||
| expression |
1..1 | Expression | An expression that provides the dynamic value for the customization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
 extension:description |
0..1 | string | STU3: Natural language description of the dynamic value additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.dynamicValue.description Constraints: ext-1 | |||||
| extension:language |
0..1 | string | STU3: Language of the expression additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.dynamicValue.language Constraints: ext-1 | |||||
| extension:expression |
0..1 | string | STU3: expression additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.dynamicValue.expression Constraints: ext-1 | |||||
| description |
Σ | 0..1 | string | Natural language description of the condition | ||||
| name |
Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
| language |
Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
| ||||
| expression |
Σ | 0..1 | string | Expression in specified language | ||||
| reference |
Σ | 0..1 | uri | Where the expression is found | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ActivityDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.topic | Base | example | DefinitionTopic | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.kind | Base | required | RequestResourceType | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.product[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.dynamicValue.expression.language | Base | extensible | ExpressionLanguage | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| adf-0 | warning | ActivityDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | 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()
|
| dom-5 | error | ActivityDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ActivityDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ActivityDefinition.meta, ActivityDefinition.implicitRules, ActivityDefinition.language, ActivityDefinition.text, ActivityDefinition.extension, ActivityDefinition.extension:contributor, ActivityDefinition.modifierExtension, ActivityDefinition.url, ActivityDefinition.identifier, ActivityDefinition.version, ActivityDefinition.name, ActivityDefinition.title, ActivityDefinition.subtitle, ActivityDefinition.status, ActivityDefinition.experimental, ActivityDefinition.subject[x], ActivityDefinition.date, ActivityDefinition.publisher, ActivityDefinition.contact, ActivityDefinition.description, ActivityDefinition.useContext, ActivityDefinition.jurisdiction, ActivityDefinition.purpose, ActivityDefinition.usage, ActivityDefinition.copyright, ActivityDefinition.approvalDate, ActivityDefinition.lastReviewDate, ActivityDefinition.effectivePeriod, ActivityDefinition.topic, ActivityDefinition.author, ActivityDefinition.editor, ActivityDefinition.reviewer, ActivityDefinition.endorser, ActivityDefinition.relatedArtifact, ActivityDefinition.library, ActivityDefinition.library.extension, ActivityDefinition.library.extension:library, ActivityDefinition.kind, ActivityDefinition.profile, ActivityDefinition.code, ActivityDefinition.intent, ActivityDefinition.priority, ActivityDefinition.doNotPerform, ActivityDefinition.timing[x], ActivityDefinition.location, ActivityDefinition.participant, ActivityDefinition.participant.extension, ActivityDefinition.participant.modifierExtension, ActivityDefinition.participant.type, ActivityDefinition.participant.role, ActivityDefinition.product[x], ActivityDefinition.quantity, ActivityDefinition.dosage, ActivityDefinition.bodySite, ActivityDefinition.specimenRequirement, ActivityDefinition.observationRequirement, ActivityDefinition.observationResultRequirement, ActivityDefinition.transform, ActivityDefinition.transform.extension, ActivityDefinition.transform.extension:transform, ActivityDefinition.dynamicValue, ActivityDefinition.dynamicValue.extension, ActivityDefinition.dynamicValue.modifierExtension, ActivityDefinition.dynamicValue.path, ActivityDefinition.dynamicValue.expression, ActivityDefinition.dynamicValue.expression.extension, ActivityDefinition.dynamicValue.expression.extension:description, ActivityDefinition.dynamicValue.expression.extension:language, ActivityDefinition.dynamicValue.expression.extension:expression, ActivityDefinition.dynamicValue.expression.description, ActivityDefinition.dynamicValue.expression.name, ActivityDefinition.dynamicValue.expression.language, ActivityDefinition.dynamicValue.expression.expression, ActivityDefinition.dynamicValue.expression.reference | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ActivityDefinition.extension, ActivityDefinition.extension:contributor, ActivityDefinition.modifierExtension, ActivityDefinition.library.extension, ActivityDefinition.library.extension:library, ActivityDefinition.participant.extension, ActivityDefinition.participant.modifierExtension, ActivityDefinition.transform.extension, ActivityDefinition.transform.extension:transform, ActivityDefinition.dynamicValue.extension, ActivityDefinition.dynamicValue.modifierExtension, ActivityDefinition.dynamicValue.expression.extension, ActivityDefinition.dynamicValue.expression.extension:description, ActivityDefinition.dynamicValue.expression.extension:language, ActivityDefinition.dynamicValue.expression.extension:expression | 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ActivityDefinition |
C | 0..* | ActivityDefinition(4.0.1) | The definition of a specific activity to be taken, independent of any particular patient or context Constraints: adf-0 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:contributor |
0..* | Contributor | STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.contributor Constraints: ext-1 | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| doNotPerform |
?!Σ | 0..1 | boolean | True if the activity should not be performed |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ActivityDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| adf-0 | warning | ActivityDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | 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()
|
| dom-5 | error | ActivityDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ActivityDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ActivityDefinition.implicitRules, ActivityDefinition.extension, ActivityDefinition.extension:contributor, ActivityDefinition.modifierExtension, ActivityDefinition.status, ActivityDefinition.doNotPerform | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ActivityDefinition.extension, ActivityDefinition.extension:contributor, ActivityDefinition.modifierExtension | 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 |
C | 0..* | ActivityDefinition(4.0.1) | The definition of a specific activity to be taken, independent of any particular patient or context Constraints: adf-0 | ||||
| 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: CommonLanguages (preferred): 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 Constraints: ext-1 | |||||
| extension:contributor |
0..* | Contributor | STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.contributor Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the activity definition | ||||
| version |
Σ | 0..1 | string | Business version of the activity definition | ||||
| name |
ΣC | 0..1 | string | Name for this activity definition (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this activity definition (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the activity definition | |||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subject[x] |
0..1 | Type of individual the activity definition is intended for Binding: SubjectType (extensible): The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the activity definition | ||||
| useContext |
Σ | 0..* | UsageContext | The context that 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. | ||||
| purpose |
0..1 | markdown | Why this activity definition is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the activity definition | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| 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 | ||||
| topic |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
| author |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
| library |
0..* | canonical(Library) | Logic used by the activity definition | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:library |
0..* | Reference(Cross-version Profile for STU3.Library for use in FHIR R4(0.1.0) | Library) | STU3: Logic used by the asset additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.library Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| kind |
Σ | 0..1 | code | Kind of resource Binding: RequestResourceType (required): The kind of activity the definition is describing. | ||||
| profile |
0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to | |||||
| code |
Σ | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed type of the activity; e.g. CBC. | ||||
| intent |
0..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request. | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if the activity should not be performed | ||||
| timing[x] |
0..1 | When activity is to occur | ||||||
| timingTiming |
Timing | |||||||
| timingDateTime |
dateTime | |||||||
| timingAge |
Age | |||||||
| timingPeriod |
Period | |||||||
| timingRange |
Range | |||||||
| timingDuration |
Duration | |||||||
| location |
0..1 | Reference(Location) | Where it should happen | |||||
| participant |
0..* | BackboneElement | Who should participate in the action | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| type |
1..1 | code | patient | practitioner | related-person | device Binding: ActionParticipantType (required): The type of participant in the activity. | |||||
| 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: SNOMEDCTMedicationCodes (example): Code describing the type of substance or medication. | ||||||
| productReference |
Reference(Medication | Substance) | |||||||
| productCodeableConcept |
CodeableConcept | |||||||
| quantity |
0..1 | SimpleQuantity(4.0.1) | How much is administered/consumed/supplied | |||||
| dosage |
0..* | Dosage | Detailed dosage instructions | |||||
| bodySite |
0..* | CodeableConcept | What part of body to perform on Binding: SNOMEDCTBodyStructures (example): A code that identifies the anatomical location. | |||||
| specimenRequirement |
0..* | Reference(SpecimenDefinition) | What specimens are required to perform this action | |||||
| observationRequirement |
0..* | Reference(ObservationDefinition) | What observations are required to perform this action | |||||
| observationResultRequirement |
0..* | Reference(ObservationDefinition) | What observations must be produced by this action | |||||
| transform |
0..1 | canonical(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 Constraints: ext-1 | |||||
| extension:transform |
0..1 | Reference(Cross-version Profile for STU3.StructureMap for use in FHIR R4(0.1.0) | StructureMap) | STU3: transform additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.transform Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| dynamicValue |
0..* | BackboneElement | Dynamic aspects of the definition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| path |
1..1 | string | The path to the element to be set dynamically | |||||
| expression |
1..1 | Expression | An expression that provides the dynamic value for the customization | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:description |
0..1 | string | STU3: Natural language description of the dynamic value additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.dynamicValue.description Constraints: ext-1 | |||||
| extension:language |
0..1 | string | STU3: Language of the expression additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.dynamicValue.language Constraints: ext-1 | |||||
| extension:expression |
0..1 | string | STU3: expression additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ActivityDefinition.dynamicValue.expression Constraints: ext-1 | |||||
| description |
Σ | 0..1 | string | Natural language description of the condition | ||||
| name |
Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
| language |
Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
| ||||
| expression |
Σ | 0..1 | string | Expression in specified language | ||||
| reference |
Σ | 0..1 | uri | Where the expression is found | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ActivityDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.subject[x] | Base | extensible | Subject type | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.topic | Base | example | DefinitionTopic | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.kind | Base | required | RequestResourceType | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.participant.type | Base | required | ActionParticipantType | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.participant.role | Base | example | Action participant role | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.product[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| ActivityDefinition.dynamicValue.expression.language | Base | extensible | ExpressionLanguage | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| adf-0 | warning | ActivityDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | 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()
|
| dom-5 | error | ActivityDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ActivityDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ActivityDefinition.meta, ActivityDefinition.implicitRules, ActivityDefinition.language, ActivityDefinition.text, ActivityDefinition.extension, ActivityDefinition.extension:contributor, ActivityDefinition.modifierExtension, ActivityDefinition.url, ActivityDefinition.identifier, ActivityDefinition.version, ActivityDefinition.name, ActivityDefinition.title, ActivityDefinition.subtitle, ActivityDefinition.status, ActivityDefinition.experimental, ActivityDefinition.subject[x], ActivityDefinition.date, ActivityDefinition.publisher, ActivityDefinition.contact, ActivityDefinition.description, ActivityDefinition.useContext, ActivityDefinition.jurisdiction, ActivityDefinition.purpose, ActivityDefinition.usage, ActivityDefinition.copyright, ActivityDefinition.approvalDate, ActivityDefinition.lastReviewDate, ActivityDefinition.effectivePeriod, ActivityDefinition.topic, ActivityDefinition.author, ActivityDefinition.editor, ActivityDefinition.reviewer, ActivityDefinition.endorser, ActivityDefinition.relatedArtifact, ActivityDefinition.library, ActivityDefinition.library.extension, ActivityDefinition.library.extension:library, ActivityDefinition.kind, ActivityDefinition.profile, ActivityDefinition.code, ActivityDefinition.intent, ActivityDefinition.priority, ActivityDefinition.doNotPerform, ActivityDefinition.timing[x], ActivityDefinition.location, ActivityDefinition.participant, ActivityDefinition.participant.extension, ActivityDefinition.participant.modifierExtension, ActivityDefinition.participant.type, ActivityDefinition.participant.role, ActivityDefinition.product[x], ActivityDefinition.quantity, ActivityDefinition.dosage, ActivityDefinition.bodySite, ActivityDefinition.specimenRequirement, ActivityDefinition.observationRequirement, ActivityDefinition.observationResultRequirement, ActivityDefinition.transform, ActivityDefinition.transform.extension, ActivityDefinition.transform.extension:transform, ActivityDefinition.dynamicValue, ActivityDefinition.dynamicValue.extension, ActivityDefinition.dynamicValue.modifierExtension, ActivityDefinition.dynamicValue.path, ActivityDefinition.dynamicValue.expression, ActivityDefinition.dynamicValue.expression.extension, ActivityDefinition.dynamicValue.expression.extension:description, ActivityDefinition.dynamicValue.expression.extension:language, ActivityDefinition.dynamicValue.expression.extension:expression, ActivityDefinition.dynamicValue.expression.description, ActivityDefinition.dynamicValue.expression.name, ActivityDefinition.dynamicValue.expression.language, ActivityDefinition.dynamicValue.expression.expression, ActivityDefinition.dynamicValue.expression.reference | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ActivityDefinition.extension, ActivityDefinition.extension:contributor, ActivityDefinition.modifierExtension, ActivityDefinition.library.extension, ActivityDefinition.library.extension:library, ActivityDefinition.participant.extension, ActivityDefinition.participant.modifierExtension, ActivityDefinition.transform.extension, ActivityDefinition.transform.extension:transform, ActivityDefinition.dynamicValue.extension, ActivityDefinition.dynamicValue.modifierExtension, ActivityDefinition.dynamicValue.expression.extension, ActivityDefinition.dynamicValue.expression.extension:description, ActivityDefinition.dynamicValue.expression.extension:language, ActivityDefinition.dynamicValue.expression.extension:expression | 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-r3.r4#0.1.0 based on FHIR 4.0.1. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
