STU 3 Candidate
This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
StructureDefinition for protocol
{
"resourceType": "StructureDefinition",
"id": "Protocol",
"meta": {
"lastUpdated": "2016-03-31T08:01:25.570+11: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/Protocol",
"name": "Protocol",
"status": "draft",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}
]
}
],
"date": "2016-03-31T08:01:25+11:00",
"description": "Base StructureDefinition for Protocol Resource",
"fhirVersion": "1.4.0",
"mapping": [
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"kind": "resource",
"abstract": false,
"baseType": "DomainResource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"path": "Protocol",
"short": "Contextual set of behaviors",
"definition": "A definition of behaviors to be taken in particular circumstances, often including conditions, options and other decision points.",
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "clinical.careprovision"
}
]
},
{
"path": "Protocol.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. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"path": "Protocol.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
},
{
"path": "Protocol.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
},
{
"path": "Protocol.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": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Protocol.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.",
"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?"
}
]
},
{
"path": "Protocol.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"
}
]
},
{
"path": "Protocol.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"
}
]
},
{
"path": "Protocol.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"
}
]
},
{
"path": "Protocol.identifier",
"short": "Unique Id for this particular protocol",
"definition": "A unique identifier for the protocol instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "Protocol.title",
"short": "Name of protocol",
"definition": "Name of protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "Protocol.status",
"short": "draft | testing | review | active | withdrawn | superseded",
"definition": "The status of the protocol.",
"requirements": "Allow for filtering of Protocols that are appropriate for use in production.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/protocol-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "Protocol.type",
"short": "condition | device | drug | study",
"definition": "A code that classifies the general type of context to which these behavior definitions apply. This is used for searching, sorting and display purposes.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "High-level categorization of the protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/protocol-type"
}
},
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "Protocol.subject",
"short": "What does protocol deal with?",
"definition": "What does protocol deal with?",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Condition"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Device"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Medication"
]
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "what"
}
]
},
{
"path": "Protocol.group",
"short": "To whom does Protocol apply?",
"definition": "To whom does Protocol apply?",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Group"
]
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"path": "Protocol.purpose",
"short": "When is protocol to be used?",
"definition": "When is protocol to be used?",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "context"
}
]
},
{
"path": "Protocol.author",
"short": "Who wrote protocol?",
"definition": "Who wrote protocol?",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.author"
}
]
},
{
"path": "Protocol.step",
"short": "What's done as part of protocol",
"definition": "What's done as part of protocol.",
"alias": [
"item"
],
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"path": "Protocol.step.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Protocol.step.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"
}
]
},
{
"path": "Protocol.step.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"
}
]
},
{
"path": "Protocol.step.name",
"short": "Label for step",
"definition": "Label for step.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Protocol.step.description",
"short": "Human description of activity",
"definition": "Human description of activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Protocol.step.duration",
"short": "How long does step last?",
"definition": "How long does step last?",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Duration"
]
}
],
"isSummary": true
},
{
"id": "precondition",
"path": "Protocol.step.precondition",
"short": "Rules prior to execution",
"definition": "Rules prior to execution.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ptl-1",
"severity": "error",
"human": "Only one of condition, intersection, union or exclude may be present",
"xpath": "(count(f:condition) + count(f:intersection[1]) + count(f:union[1]) + count(f:exclude[1])) <= 1"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.precondition.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Protocol.step.precondition.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"
}
]
},
{
"path": "Protocol.step.precondition.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"
}
]
},
{
"path": "Protocol.step.precondition.description",
"short": "Description of condition",
"definition": "Human-readable description of the condition.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Protocol.step.precondition.condition",
"short": "Condition evaluated",
"definition": "Defines the name/value pair that must hold for the condition to be met.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"ptl-1"
],
"isSummary": true
},
{
"path": "Protocol.step.precondition.condition.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Protocol.step.precondition.condition.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"
}
]
},
{
"path": "Protocol.step.precondition.condition.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"
}
]
},
{
"path": "Protocol.step.precondition.condition.type",
"short": "Observation / test / assertion",
"definition": "The type of observation, test or other assertion being evaluated by the condition.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Type of observation used as basis for conditional execution of one or more activities"
}
},
{
"path": "Protocol.step.precondition.condition.value[x]",
"short": "Value needed to satisfy condition",
"definition": "Indicates what value the observation/test/assertion must have in order for the condition to be considered to be satisfied.",
"comments": "If the value is an interval, the condition matches if the value falls within the interval. The binding of .condition.valueCodeableConcept is unbound and is a coded value of an observation used as basis for conditional execution of one or more activities.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "boolean"
},
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
},
{
"code": "Range"
}
],
"isSummary": true
},
{
"path": "Protocol.step.precondition.intersection",
"short": "And conditions",
"definition": "Lists a set of conditions that must all be met.",
"min": 0,
"max": "*",
"contentReference": "#precondition",
"condition": [
"ptl-1"
],
"isSummary": true
},
{
"path": "Protocol.step.precondition.union",
"short": "Or conditions",
"definition": "Lists alternative conditions, at least one of must be met.",
"min": 0,
"max": "*",
"contentReference": "#precondition",
"condition": [
"ptl-1"
],
"isSummary": true
},
{
"path": "Protocol.step.precondition.exclude",
"short": "Not conditions",
"definition": "Lists conditions of which none must be met.",
"min": 0,
"max": "*",
"contentReference": "#precondition",
"condition": [
"ptl-1"
],
"isSummary": true
},
{
"path": "Protocol.step.exit",
"short": "Rules prior to completion",
"definition": "Indicates the conditions that must be met for activities that are part of this time point to terminate.",
"comments": "If not specified, activities end based on occurrence and duration information specified in the activity. Conditions specified here may be used to allow exception handling as well as to ensure certain conditions are met while activities are proceeding.",
"min": 0,
"max": "1",
"contentReference": "#precondition",
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.firstActivity",
"short": "First activity within timepoint",
"definition": "First activity within timepoint.",
"comments": "Multiple activities are assumed to start in parallel.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity",
"short": "Activities that occur within timepoint",
"definition": "Activities that occur within timepoint.",
"comments": "We send them as a collection because a single activity may be referenced multiple times; e.g. Activity C may be a follow-on activity to both A and B which happen in parallel.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Protocol.step.activity.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"
}
]
},
{
"path": "Protocol.step.activity.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"
}
]
},
{
"path": "Protocol.step.activity.alternative",
"short": "What can be done instead?",
"definition": "What can be done instead?",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity.component",
"short": "Activities that are part of this activity",
"definition": "Activities that are part of this activity.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"path": "Protocol.step.activity.component.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Protocol.step.activity.component.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"
}
]
},
{
"path": "Protocol.step.activity.component.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"
}
]
},
{
"path": "Protocol.step.activity.component.sequence",
"short": "Order of occurrence",
"definition": "Order of occurrence.",
"comments": "Equivalent values happen in parallel.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity.component.activity",
"short": "Component activity",
"definition": "Component activity.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"path": "Protocol.step.activity.following",
"short": "What happens next",
"definition": "What happens next.",
"comments": "Multiple activities are assumed to start in parallel.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity.wait",
"short": "Pause before start",
"definition": "Indicates the length of time to wait between the conditions being satisfied for the activity to start and the actual start of the activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Duration"
]
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity.detail",
"short": "Details of activity",
"definition": "Information about the nature of the activity, including type, timing and other qualifiers.",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity.detail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Protocol.step.activity.detail.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"
}
]
},
{
"path": "Protocol.step.activity.detail.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"
}
]
},
{
"path": "Protocol.step.activity.detail.category",
"short": "diet | drug | encounter | observation +",
"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"
}
],
"isSummary": true,
"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"
}
},
"mapping": [
{
"identity": "rim",
"map": ".classCode"
}
]
},
{
"path": "Protocol.step.activity.detail.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"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Detailed type of planned activity; e.g. CBC"
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Protocol.step.activity.detail.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"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Code describing the timing of an activity; e.g. BID, QD"
},
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Protocol.step.activity.detail.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"
]
}
],
"isSummary": true
},
{
"path": "Protocol.step.activity.detail.performer",
"short": "Who's responsible?",
"definition": "Identifies who's expected to be involved in the activity.",
"requirements": "Helps in planning of activity.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
],
"isSummary": true
},
{
"path": "Protocol.step.activity.detail.product",
"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"
]
}
],
"isSummary": true
},
{
"path": "Protocol.step.activity.detail.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"
]
}
],
"isSummary": true
},
{
"path": "Protocol.step.activity.detail.description",
"short": "Extra info on activity occurrence",
"definition": "This provides a textual description of constraints on the activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Protocol.step.next",
"short": "What happens next?",
"definition": "What happens next?",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"path": "Protocol.step.next.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Protocol.step.next.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"
}
]
},
{
"path": "Protocol.step.next.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"
}
]
},
{
"path": "Protocol.step.next.description",
"short": "Description of what happens next",
"definition": "Description of what happens next.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Protocol.step.next.reference",
"short": "Id of following step",
"definition": "Id of following step.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"path": "Protocol.step.next.condition",
"short": "Condition in which next step is executed",
"definition": "Condition in which next step is executed.",
"min": 0,
"max": "1",
"contentReference": "#precondition",
"isSummary": true
}
]
},
"differential": {
"element": [
{
"path": "Protocol",
"short": "Contextual set of behaviors",
"definition": "A definition of behaviors to be taken in particular circumstances, often including conditions, options and other decision points.",
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "clinical.careprovision"
}
]
},
{
"path": "Protocol.identifier",
"short": "Unique Id for this particular protocol",
"definition": "A unique identifier for the protocol instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "Protocol.title",
"short": "Name of protocol",
"definition": "Name of protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "Protocol.status",
"short": "draft | testing | review | active | withdrawn | superseded",
"definition": "The status of the protocol.",
"requirements": "Allow for filtering of Protocols that are appropriate for use in production.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/protocol-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "Protocol.type",
"short": "condition | device | drug | study",
"definition": "A code that classifies the general type of context to which these behavior definitions apply. This is used for searching, sorting and display purposes.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "High-level categorization of the protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/protocol-type"
}
},
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "Protocol.subject",
"short": "What does protocol deal with?",
"definition": "What does protocol deal with?",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Condition"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Device"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Medication"
]
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "what"
}
]
},
{
"path": "Protocol.group",
"short": "To whom does Protocol apply?",
"definition": "To whom does Protocol apply?",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Group"
]
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"path": "Protocol.purpose",
"short": "When is protocol to be used?",
"definition": "When is protocol to be used?",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "context"
}
]
},
{
"path": "Protocol.author",
"short": "Who wrote protocol?",
"definition": "Who wrote protocol?",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.author"
}
]
},
{
"path": "Protocol.step",
"short": "What's done as part of protocol",
"definition": "What's done as part of protocol.",
"alias": [
"item"
],
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"path": "Protocol.step.name",
"short": "Label for step",
"definition": "Label for step.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Protocol.step.description",
"short": "Human description of activity",
"definition": "Human description of activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Protocol.step.duration",
"short": "How long does step last?",
"definition": "How long does step last?",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Duration"
]
}
],
"isSummary": true
},
{
"id": "precondition",
"path": "Protocol.step.precondition",
"short": "Rules prior to execution",
"definition": "Rules prior to execution.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ptl-1",
"severity": "error",
"human": "Only one of condition, intersection, union or exclude may be present",
"xpath": "(count(f:condition) + count(f:intersection[1]) + count(f:union[1]) + count(f:exclude[1])) <= 1"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.precondition.description",
"short": "Description of condition",
"definition": "Human-readable description of the condition.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Protocol.step.precondition.condition",
"short": "Condition evaluated",
"definition": "Defines the name/value pair that must hold for the condition to be met.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"ptl-1"
],
"isSummary": true
},
{
"path": "Protocol.step.precondition.condition.type",
"short": "Observation / test / assertion",
"definition": "The type of observation, test or other assertion being evaluated by the condition.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Type of observation used as basis for conditional execution of one or more activities"
}
},
{
"path": "Protocol.step.precondition.condition.value[x]",
"short": "Value needed to satisfy condition",
"definition": "Indicates what value the observation/test/assertion must have in order for the condition to be considered to be satisfied.",
"comments": "If the value is an interval, the condition matches if the value falls within the interval. The binding of .condition.valueCodeableConcept is unbound and is a coded value of an observation used as basis for conditional execution of one or more activities.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "boolean"
},
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
},
{
"code": "Range"
}
],
"isSummary": true
},
{
"path": "Protocol.step.precondition.intersection",
"short": "And conditions",
"definition": "Lists a set of conditions that must all be met.",
"min": 0,
"max": "*",
"contentReference": "#precondition",
"condition": [
"ptl-1"
],
"isSummary": true
},
{
"path": "Protocol.step.precondition.union",
"short": "Or conditions",
"definition": "Lists alternative conditions, at least one of must be met.",
"min": 0,
"max": "*",
"contentReference": "#precondition",
"condition": [
"ptl-1"
],
"isSummary": true
},
{
"path": "Protocol.step.precondition.exclude",
"short": "Not conditions",
"definition": "Lists conditions of which none must be met.",
"min": 0,
"max": "*",
"contentReference": "#precondition",
"condition": [
"ptl-1"
],
"isSummary": true
},
{
"path": "Protocol.step.exit",
"short": "Rules prior to completion",
"definition": "Indicates the conditions that must be met for activities that are part of this time point to terminate.",
"comments": "If not specified, activities end based on occurrence and duration information specified in the activity. Conditions specified here may be used to allow exception handling as well as to ensure certain conditions are met while activities are proceeding.",
"min": 0,
"max": "1",
"contentReference": "#precondition",
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.firstActivity",
"short": "First activity within timepoint",
"definition": "First activity within timepoint.",
"comments": "Multiple activities are assumed to start in parallel.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity",
"short": "Activities that occur within timepoint",
"definition": "Activities that occur within timepoint.",
"comments": "We send them as a collection because a single activity may be referenced multiple times; e.g. Activity C may be a follow-on activity to both A and B which happen in parallel.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity.alternative",
"short": "What can be done instead?",
"definition": "What can be done instead?",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity.component",
"short": "Activities that are part of this activity",
"definition": "Activities that are part of this activity.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"path": "Protocol.step.activity.component.sequence",
"short": "Order of occurrence",
"definition": "Order of occurrence.",
"comments": "Equivalent values happen in parallel.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity.component.activity",
"short": "Component activity",
"definition": "Component activity.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"path": "Protocol.step.activity.following",
"short": "What happens next",
"definition": "What happens next.",
"comments": "Multiple activities are assumed to start in parallel.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity.wait",
"short": "Pause before start",
"definition": "Indicates the length of time to wait between the conditions being satisfied for the activity to start and the actual start of the activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Duration"
]
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity.detail",
"short": "Details of activity",
"definition": "Information about the nature of the activity, including type, timing and other qualifiers.",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Protocol.step.activity.detail.category",
"short": "diet | drug | encounter | observation +",
"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"
}
],
"isSummary": true,
"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"
}
},
"mapping": [
{
"identity": "rim",
"map": ".classCode"
}
]
},
{
"path": "Protocol.step.activity.detail.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"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Detailed type of planned activity; e.g. CBC"
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Protocol.step.activity.detail.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"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Code describing the timing of an activity; e.g. BID, QD"
},
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Protocol.step.activity.detail.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"
]
}
],
"isSummary": true
},
{
"path": "Protocol.step.activity.detail.performer",
"short": "Who's responsible?",
"definition": "Identifies who's expected to be involved in the activity.",
"requirements": "Helps in planning of activity.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
],
"isSummary": true
},
{
"path": "Protocol.step.activity.detail.product",
"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"
]
}
],
"isSummary": true
},
{
"path": "Protocol.step.activity.detail.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"
]
}
],
"isSummary": true
},
{
"path": "Protocol.step.activity.detail.description",
"short": "Extra info on activity occurrence",
"definition": "This provides a textual description of constraints on the activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Protocol.step.next",
"short": "What happens next?",
"definition": "What happens next?",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"path": "Protocol.step.next.description",
"short": "Description of what happens next",
"definition": "Description of what happens next.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Protocol.step.next.reference",
"short": "Id of following step",
"definition": "Id of following step.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"path": "Protocol.step.next.condition",
"short": "Condition in which next step is executed",
"definition": "Condition in which next step is executed.",
"min": 0,
"max": "1",
"contentReference": "#precondition",
"isSummary": true
}
]
}
}
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 Candidate (v1.4.0-8139) generated on Thu, Mar 31, 2016 08:09+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change