STU 3 Ballot
Clinical ReasoningThis page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3
StructureDefinition for activitydefinition
{
"resourceType": "StructureDefinition",
"id": "ActivityDefinition",
"meta": {
"lastUpdated": "2016-08-11T17:02:54.322+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
}
],
"url": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"name": "ActivityDefinition",
"status": "draft",
"publisher": "Health Level Seven International (Clinical Decision Support)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/dss/index.cfm"
}
]
}
],
"date": "2016-08-11T17:02:54+10:00",
"description": "Base StructureDefinition for ActivityDefinition Resource",
"fhirVersion": "1.6.0",
"mapping": [
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "ActivityDefinition",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "ActivityDefinition",
"path": "ActivityDefinition",
"short": "The definition of a specific activity to be taken, independent of any particular patient or context",
"definition": "This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"id": "ActivityDefinition.id",
"path": "ActivityDefinition.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "ActivityDefinition.meta",
"path": "ActivityDefinition.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "ActivityDefinition.implicitRules",
"path": "ActivityDefinition.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"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 as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "ActivityDefinition.language",
"path": "ActivityDefinition.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "ActivityDefinition.text",
"path": "ActivityDefinition.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "ActivityDefinition.contained",
"path": "ActivityDefinition.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ActivityDefinition.extension",
"path": "ActivityDefinition.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ActivityDefinition.modifierExtension",
"path": "ActivityDefinition.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ActivityDefinition.url",
"path": "ActivityDefinition.url",
"short": "Logical URL to reference this asset",
"definition": "An absolute URL that is used to identify this asset when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this asset is (or will be) published.",
"requirements": "Allows the asset to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ActivityDefinition.identifier",
"path": "ActivityDefinition.identifier",
"short": "Logical identifier(s) for the asset",
"definition": "A logical identifier for the asset such as the CMS or NQF identifiers for a measure. Note that at least one identifier is required for non-experimental active assets.",
"requirements": "Allows external business identifiers to be easily associated with the asset.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ActivityDefinition.version",
"path": "ActivityDefinition.version",
"short": "The version of the asset, if any",
"definition": "The version of the asset, if any. 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.",
"requirements": "Allows for versioning of the content of the asset.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ActivityDefinition.name",
"path": "ActivityDefinition.name",
"short": "A machine-friendly name for the asset",
"definition": "A machine-friendly name for the asset. This name should be usable as an identifier for the asset by machine processing applications such as code generation.",
"comments": "This identifier for the asset should be unique within the intended scope of use, and should conform to the traditional syntactic definition of an identifier within most programming languages. regex: ([A-Za-z_][A-Za-z0-9_]*).",
"requirements": "Simplifies machine-processing tasks related to the asset such as code-generation or logging.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ActivityDefinition.title",
"path": "ActivityDefinition.title",
"short": "A user-friendly title for the asset",
"definition": "A short, descriptive, user-friendly title for the asset.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ActivityDefinition.status",
"path": "ActivityDefinition.status",
"short": "draft | active | inactive",
"definition": "The status of the asset.",
"requirements": "Enables tracking the life-cycle of the content of the asset.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The status of the ActivityDefinition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/module-metadata-status"
}
}
},
{
"id": "ActivityDefinition.experimental",
"path": "ActivityDefinition.experimental",
"short": "If for testing purposes, not real usage",
"definition": "Determines whether the asset was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments.",
"requirements": "Enables experimental content to be developed following the same life-cycle as a production-level asset would.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "ActivityDefinition.description",
"path": "ActivityDefinition.description",
"short": "Natural language description of the asset",
"definition": "A free text natural language description of the asset from the consumer's perspective.",
"comments": "This description can be used to capture details such as why the asset was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the asset as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.purpose",
"path": "ActivityDefinition.purpose",
"short": "Describes the purpose of the asset",
"definition": "A brief description of the purpose of the asset.",
"comments": "This description should address the question of why this asset was built, though not necessarily in as much detail as the justification, rationale, or clinical recommendation statement of a measure would. That information would typically be provided in the related resource element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.usage",
"path": "ActivityDefinition.usage",
"short": "Describes the clinical usage of the asset",
"definition": "A detailed description of how the asset is used from a clinical perspective.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.publicationDate",
"path": "ActivityDefinition.publicationDate",
"short": "Publication date for this version of the asset",
"definition": "The date on which the asset was published.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "ActivityDefinition.lastReviewDate",
"path": "ActivityDefinition.lastReviewDate",
"short": "Last review date for the asset",
"definition": "The date on which the asset content was last reviewed.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "ActivityDefinition.effectivePeriod",
"path": "ActivityDefinition.effectivePeriod",
"short": "The effective date range for the asset",
"definition": "The period during which the asset content is effective.",
"comments": "The effective period for an asset determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"id": "ActivityDefinition.coverage",
"path": "ActivityDefinition.coverage",
"short": "Describes the context of use for this asset",
"definition": "Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge asset is applicable.",
"requirements": "Consumers of the asset must be able to determine the intended applicability for the asset. Ideally, this information would be used programmatically to determine when and how it should be incorporated or exposed.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
]
},
{
"id": "ActivityDefinition.topic",
"path": "ActivityDefinition.topic",
"short": "Descriptional topics for the asset",
"definition": "Clinical topics related to the content of the asset.",
"requirements": "Repositories must be able to determine how to categorize the asset so that it can be found by topical searches.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "ActivityDefinition.contributor",
"path": "ActivityDefinition.contributor",
"short": "A content contributor",
"definition": "A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.",
"requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the knowledge asset.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contributor"
}
]
},
{
"id": "ActivityDefinition.publisher",
"path": "ActivityDefinition.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the asset (also known as the steward for the asset). This information is required for non-experimental active artifacts.",
"comments": "The publisher (or steward) of the module is the organization or individual primarily responsible for the maintenance and upkeep of the module. This is not necessarily the same organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the module.",
"requirements": "Consumers of the asset must be able to determine where to obtain support in the use of this asset, as well as where to direct questions and concerns about the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.contact",
"path": "ActivityDefinition.contact",
"short": "Contact details of the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
]
},
{
"id": "ActivityDefinition.copyright",
"path": "ActivityDefinition.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the asset and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the asset.",
"requirements": "Consumers of the asset must be able to determine any legal restrictions on the use of the asset and/or its content.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.relatedResource",
"path": "ActivityDefinition.relatedResource",
"short": "Related resources for the asset",
"definition": "Related resources such as additional documentation, justification, or bibliographic references.",
"comments": "Each related resource is either an attachment, or a reference to another resource, but not both.",
"requirements": "Assets 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.",
"min": 0,
"max": "*",
"type": [
{
"code": "RelatedResource"
}
]
},
{
"id": "ActivityDefinition.library",
"path": "ActivityDefinition.library",
"short": "Logic used by the asset",
"definition": "A reference to a Library resource containing any formal logic used by the asset.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Library"
}
]
},
{
"id": "ActivityDefinition.category",
"path": "ActivityDefinition.category",
"short": "communication | device | diagnostic | diet | drug | encounter | immunization | observation | procedure | referral | supply | vision | other",
"definition": "High-level categorization of the type of activity.",
"requirements": "May determine what types of extensions are permitted.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "High-level categorization of the type of activity in a protocol.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/activity-definition-category"
}
}
},
{
"id": "ActivityDefinition.code",
"path": "ActivityDefinition.code",
"short": "Detail type of activity",
"definition": "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.",
"comments": "Tends to be less relevant for activities involving particular products.",
"requirements": "Allows matching performed to planned as well as validation against protocols.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Detailed type of planned activity; e.g. CBC"
}
},
{
"id": "ActivityDefinition.timing[x]",
"path": "ActivityDefinition.timing[x]",
"short": "When activity is to occur",
"definition": "The period, timing or frequency upon which the described activity is to occur.",
"requirements": "Allows prompting for activities and detection of missed planned activities.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Timing"
}
],
"binding": {
"strength": "example",
"description": "Code describing the timing of an activity; e.g. BID, QD"
}
},
{
"id": "ActivityDefinition.location",
"path": "ActivityDefinition.location",
"short": "Where it should happen",
"definition": "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.",
"comments": "May reference a specific clinical location or may just identify a type of location.",
"requirements": "Helps in planning of activity.",
"alias": [
"facility"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
]
},
{
"id": "ActivityDefinition.participantType",
"path": "ActivityDefinition.participantType",
"short": "patient | practitioner | related-person",
"definition": "The type of participant in the action.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The type of participant for an action in the orderset",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-participant-type"
}
}
},
{
"id": "ActivityDefinition.product[x]",
"path": "ActivityDefinition.product[x]",
"short": "What's administered/supplied",
"definition": "Identifies the food, drug or other product being consumed or supplied in the activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Code describing the type of substance or medication"
}
},
{
"id": "ActivityDefinition.quantity",
"path": "ActivityDefinition.quantity",
"short": "How much is administered/consumed/supplied",
"definition": "Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).",
"alias": [
"dose"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
]
},
{
"id": "ActivityDefinition.transform",
"path": "ActivityDefinition.transform",
"short": "Transform to apply the template",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureMap"
}
]
},
{
"id": "ActivityDefinition.dynamicValue",
"path": "ActivityDefinition.dynamicValue",
"short": "Dynamic aspects of the definition",
"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 intent resource that would contain the result.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ActivityDefinition.dynamicValue.id",
"path": "ActivityDefinition.dynamicValue.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ActivityDefinition.dynamicValue.extension",
"path": "ActivityDefinition.dynamicValue.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ActivityDefinition.dynamicValue.modifierExtension",
"path": "ActivityDefinition.dynamicValue.modifierExtension",
"short": "Extensions that cannot be ignored",
"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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ActivityDefinition.dynamicValue.description",
"path": "ActivityDefinition.dynamicValue.description",
"short": "Natural language description of the dynamic value",
"definition": "A brief, natural language description of the intended semantics of the dynamic value.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.dynamicValue.path",
"path": "ActivityDefinition.dynamicValue.path",
"short": "The path to the element to be set dynamically",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.dynamicValue.language",
"path": "ActivityDefinition.dynamicValue.language",
"short": "Language of the expression",
"definition": "The media type of the language for the expression.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.dynamicValue.expression",
"path": "ActivityDefinition.dynamicValue.expression",
"short": "An expression that provides the dynamic value for the customization",
"definition": "An expression specifying the value of the customized element.",
"comments": "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ActivityDefinition",
"path": "ActivityDefinition",
"short": "The definition of a specific activity to be taken, independent of any particular patient or context",
"definition": "This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "w5",
"map": "clinical.general"
}
]
},
{
"id": "ActivityDefinition.url",
"path": "ActivityDefinition.url",
"short": "Logical URL to reference this asset",
"definition": "An absolute URL that is used to identify this asset when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this asset is (or will be) published.",
"requirements": "Allows the asset to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ActivityDefinition.identifier",
"path": "ActivityDefinition.identifier",
"short": "Logical identifier(s) for the asset",
"definition": "A logical identifier for the asset such as the CMS or NQF identifiers for a measure. Note that at least one identifier is required for non-experimental active assets.",
"requirements": "Allows external business identifiers to be easily associated with the asset.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ActivityDefinition.version",
"path": "ActivityDefinition.version",
"short": "The version of the asset, if any",
"definition": "The version of the asset, if any. 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.",
"requirements": "Allows for versioning of the content of the asset.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ActivityDefinition.name",
"path": "ActivityDefinition.name",
"short": "A machine-friendly name for the asset",
"definition": "A machine-friendly name for the asset. This name should be usable as an identifier for the asset by machine processing applications such as code generation.",
"comments": "This identifier for the asset should be unique within the intended scope of use, and should conform to the traditional syntactic definition of an identifier within most programming languages. regex: ([A-Za-z_][A-Za-z0-9_]*).",
"requirements": "Simplifies machine-processing tasks related to the asset such as code-generation or logging.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ActivityDefinition.title",
"path": "ActivityDefinition.title",
"short": "A user-friendly title for the asset",
"definition": "A short, descriptive, user-friendly title for the asset.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ActivityDefinition.status",
"path": "ActivityDefinition.status",
"short": "draft | active | inactive",
"definition": "The status of the asset.",
"requirements": "Enables tracking the life-cycle of the content of the asset.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The status of the ActivityDefinition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/module-metadata-status"
}
}
},
{
"id": "ActivityDefinition.experimental",
"path": "ActivityDefinition.experimental",
"short": "If for testing purposes, not real usage",
"definition": "Determines whether the asset was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments.",
"requirements": "Enables experimental content to be developed following the same life-cycle as a production-level asset would.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "ActivityDefinition.description",
"path": "ActivityDefinition.description",
"short": "Natural language description of the asset",
"definition": "A free text natural language description of the asset from the consumer's perspective.",
"comments": "This description can be used to capture details such as why the asset was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the asset as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.purpose",
"path": "ActivityDefinition.purpose",
"short": "Describes the purpose of the asset",
"definition": "A brief description of the purpose of the asset.",
"comments": "This description should address the question of why this asset was built, though not necessarily in as much detail as the justification, rationale, or clinical recommendation statement of a measure would. That information would typically be provided in the related resource element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.usage",
"path": "ActivityDefinition.usage",
"short": "Describes the clinical usage of the asset",
"definition": "A detailed description of how the asset is used from a clinical perspective.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.publicationDate",
"path": "ActivityDefinition.publicationDate",
"short": "Publication date for this version of the asset",
"definition": "The date on which the asset was published.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "ActivityDefinition.lastReviewDate",
"path": "ActivityDefinition.lastReviewDate",
"short": "Last review date for the asset",
"definition": "The date on which the asset content was last reviewed.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "ActivityDefinition.effectivePeriod",
"path": "ActivityDefinition.effectivePeriod",
"short": "The effective date range for the asset",
"definition": "The period during which the asset content is effective.",
"comments": "The effective period for an asset determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"id": "ActivityDefinition.coverage",
"path": "ActivityDefinition.coverage",
"short": "Describes the context of use for this asset",
"definition": "Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge asset is applicable.",
"requirements": "Consumers of the asset must be able to determine the intended applicability for the asset. Ideally, this information would be used programmatically to determine when and how it should be incorporated or exposed.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
]
},
{
"id": "ActivityDefinition.topic",
"path": "ActivityDefinition.topic",
"short": "Descriptional topics for the asset",
"definition": "Clinical topics related to the content of the asset.",
"requirements": "Repositories must be able to determine how to categorize the asset so that it can be found by topical searches.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "ActivityDefinition.contributor",
"path": "ActivityDefinition.contributor",
"short": "A content contributor",
"definition": "A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.",
"requirements": "Consumers of the content must be able to quickly determine who contributed to the content of the knowledge asset.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contributor"
}
]
},
{
"id": "ActivityDefinition.publisher",
"path": "ActivityDefinition.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the asset (also known as the steward for the asset). This information is required for non-experimental active artifacts.",
"comments": "The publisher (or steward) of the module is the organization or individual primarily responsible for the maintenance and upkeep of the module. This is not necessarily the same organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the module.",
"requirements": "Consumers of the asset must be able to determine where to obtain support in the use of this asset, as well as where to direct questions and concerns about the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.contact",
"path": "ActivityDefinition.contact",
"short": "Contact details of the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
]
},
{
"id": "ActivityDefinition.copyright",
"path": "ActivityDefinition.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the asset and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the asset.",
"requirements": "Consumers of the asset must be able to determine any legal restrictions on the use of the asset and/or its content.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.relatedResource",
"path": "ActivityDefinition.relatedResource",
"short": "Related resources for the asset",
"definition": "Related resources such as additional documentation, justification, or bibliographic references.",
"comments": "Each related resource is either an attachment, or a reference to another resource, but not both.",
"requirements": "Assets 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.",
"min": 0,
"max": "*",
"type": [
{
"code": "RelatedResource"
}
]
},
{
"id": "ActivityDefinition.library",
"path": "ActivityDefinition.library",
"short": "Logic used by the asset",
"definition": "A reference to a Library resource containing any formal logic used by the asset.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Library"
}
]
},
{
"id": "ActivityDefinition.category",
"path": "ActivityDefinition.category",
"short": "communication | device | diagnostic | diet | drug | encounter | immunization | observation | procedure | referral | supply | vision | other",
"definition": "High-level categorization of the type of activity.",
"requirements": "May determine what types of extensions are permitted.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "High-level categorization of the type of activity in a protocol.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/activity-definition-category"
}
}
},
{
"id": "ActivityDefinition.code",
"path": "ActivityDefinition.code",
"short": "Detail type of activity",
"definition": "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.",
"comments": "Tends to be less relevant for activities involving particular products.",
"requirements": "Allows matching performed to planned as well as validation against protocols.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Detailed type of planned activity; e.g. CBC"
}
},
{
"id": "ActivityDefinition.timing[x]",
"path": "ActivityDefinition.timing[x]",
"short": "When activity is to occur",
"definition": "The period, timing or frequency upon which the described activity is to occur.",
"requirements": "Allows prompting for activities and detection of missed planned activities.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Timing"
}
],
"binding": {
"strength": "example",
"description": "Code describing the timing of an activity; e.g. BID, QD"
}
},
{
"id": "ActivityDefinition.location",
"path": "ActivityDefinition.location",
"short": "Where it should happen",
"definition": "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.",
"comments": "May reference a specific clinical location or may just identify a type of location.",
"requirements": "Helps in planning of activity.",
"alias": [
"facility"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
]
},
{
"id": "ActivityDefinition.participantType",
"path": "ActivityDefinition.participantType",
"short": "patient | practitioner | related-person",
"definition": "The type of participant in the action.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The type of participant for an action in the orderset",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/action-participant-type"
}
}
},
{
"id": "ActivityDefinition.product[x]",
"path": "ActivityDefinition.product[x]",
"short": "What's administered/supplied",
"definition": "Identifies the food, drug or other product being consumed or supplied in the activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Code describing the type of substance or medication"
}
},
{
"id": "ActivityDefinition.quantity",
"path": "ActivityDefinition.quantity",
"short": "How much is administered/consumed/supplied",
"definition": "Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).",
"alias": [
"dose"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
]
},
{
"id": "ActivityDefinition.transform",
"path": "ActivityDefinition.transform",
"short": "Transform to apply the template",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureMap"
}
]
},
{
"id": "ActivityDefinition.dynamicValue",
"path": "ActivityDefinition.dynamicValue",
"short": "Dynamic aspects of the definition",
"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 intent resource that would contain the result.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ActivityDefinition.dynamicValue.description",
"path": "ActivityDefinition.dynamicValue.description",
"short": "Natural language description of the dynamic value",
"definition": "A brief, natural language description of the intended semantics of the dynamic value.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.dynamicValue.path",
"path": "ActivityDefinition.dynamicValue.path",
"short": "The path to the element to be set dynamically",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.dynamicValue.language",
"path": "ActivityDefinition.dynamicValue.language",
"short": "Language of the expression",
"definition": "The media type of the language for the expression.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ActivityDefinition.dynamicValue.expression",
"path": "ActivityDefinition.dynamicValue.expression",
"short": "An expression that provides the dynamic value for the customization",
"definition": "An expression specifying the value of the customized element.",
"comments": "The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change