FHIR IG Statistics: StructureDefinition/2.16.840.1.113883.10.20.22.4.24
Resources that use this resource
Resources that this resource uses
No resources found
Narrative
Note: links and images are rebased to the (stated) source
Source
{
"resourceType": "StructureDefinition",
"id": "2.16.840.1.113883.10.20.22.4.24",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.24",
"identifier": [
{
"value": "urn:oid:2.16.840.1.113883.10.20.22.4.24"
}
],
"version": "2.2",
"name": "DrugVehicle",
"title": "Drug Vehicle",
"status": "active",
"date": "2022-05-13T15:50:12+00:00",
"publisher": "Health Level Seven",
"contact": [
{
"name": "HL7 International - Structured Documents",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description": "This template represents the vehicle (e.g., saline, dextrose) for administering a medication.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "ParticipantRole",
"baseDefinition": "http://hl7.org/fhir/cda/StructureDefinition/ParticipantRole",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "ParticipantRole",
"path": "ParticipantRole",
"min": 1,
"max": "1",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "ParticipantRole.classCode",
"path": "ParticipantRole.classCode",
"representation": [
"xmlAttr"
],
"requirements": "SHALL contain exactly one [1..1] @classCode=\"MANU\" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:81-7490).",
"min": 1,
"max": "1",
"base": {
"path": "ParticipantRole.classCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"defaultValueCode": "ROL",
"patternCode": "MANU",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassRoot"
}
},
{
"id": "ParticipantRole.templateId",
"path": "ParticipantRole.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "root"
}
],
"rules": "open"
},
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id": "ParticipantRole.templateId:primary",
"path": "ParticipantRole.templateId",
"sliceName": "primary",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"requirements": "SHALL contain exactly one [1..1] templateId (CONF:81-7495) such that it",
"min": 1,
"max": "1",
"base": {
"path": "ParticipantRole.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id": "ParticipantRole.templateId:primary.nullFlavor",
"path": "ParticipantRole.templateId.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id": "ParticipantRole.templateId:primary.assigningAuthorityName",
"path": "ParticipantRole.templateId.assigningAuthorityName",
"representation": [
"xmlAttr"
],
"label": "Assigning Authority Name",
"definition": "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min": 0,
"max": "1",
"base": {
"path": "II.assigningAuthorityName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ParticipantRole.templateId:primary.displayable",
"path": "ParticipantRole.templateId.displayable",
"representation": [
"xmlAttr"
],
"label": "Displayable",
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min": 0,
"max": "1",
"base": {
"path": "II.displayable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "ParticipantRole.templateId:primary.root",
"path": "ParticipantRole.templateId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"requirements": "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.10.20.22.4.24\" (CONF:81-10493).",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"patternString": "2.16.840.1.113883.10.20.22.4.24"
},
{
"id": "ParticipantRole.templateId:primary.extension",
"path": "ParticipantRole.templateId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 0,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ParticipantRole.id",
"path": "ParticipantRole.id",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id": "ParticipantRole.sdtcIdentifiedBy",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString": "identifiedBy"
}
],
"path": "ParticipantRole.sdtcIdentifiedBy",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.sdtcIdentifiedBy",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy"
}
]
},
{
"id": "ParticipantRole.code",
"path": "ParticipantRole.code",
"requirements": "SHALL contain exactly one [1..1] code (CONF:81-19137).",
"min": 1,
"max": "1",
"base": {
"path": "ParticipantRole.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleCode"
}
},
{
"id": "ParticipantRole.code.nullFlavor",
"path": "ParticipantRole.code.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-NullFlavor"
}
},
{
"id": "ParticipantRole.code.code",
"path": "ParticipantRole.code.code",
"representation": [
"xmlAttr"
],
"label": "Code",
"definition": "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"requirements": "This code SHALL contain exactly one [1..1] @code=\"412307009\" Drug Vehicle (CONF:81-19138).",
"min": 1,
"max": "1",
"base": {
"path": "CD.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"patternString": "412307009"
},
{
"id": "ParticipantRole.code.codeSystem",
"path": "ParticipantRole.code.codeSystem",
"representation": [
"xmlAttr"
],
"label": "Code System",
"definition": "Specifies the code system that defines the code.",
"requirements": "This code SHALL contain exactly one [1..1] @codeSystem=\"2.16.840.1.113883.6.96\" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:81-26502).",
"min": 1,
"max": "1",
"base": {
"path": "CD.codeSystem",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"patternString": "2.16.840.1.113883.6.96"
},
{
"id": "ParticipantRole.code.codeSystemName",
"path": "ParticipantRole.code.codeSystemName",
"representation": [
"xmlAttr"
],
"label": "Code System Name",
"definition": "The common name of the coding system.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystemName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ParticipantRole.code.codeSystemVersion",
"path": "ParticipantRole.code.codeSystemVersion",
"representation": [
"xmlAttr"
],
"label": "Code System Version",
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystemVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ParticipantRole.code.displayName",
"path": "ParticipantRole.code.displayName",
"representation": [
"xmlAttr"
],
"label": "Display Name",
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"min": 0,
"max": "1",
"base": {
"path": "CD.displayName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ParticipantRole.code.sdtcValueSet",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString": "valueSet"
}
],
"path": "ParticipantRole.code.sdtcValueSet",
"representation": [
"xmlAttr"
],
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min": 0,
"max": "1",
"base": {
"path": "CD.valueSet",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ParticipantRole.code.sdtcValueSetVersion",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-xml-name",
"valueString": "valueSetVersion"
}
],
"path": "ParticipantRole.code.sdtcValueSetVersion",
"representation": [
"xmlAttr"
],
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min": 0,
"max": "1",
"base": {
"path": "CD.sdtcValueSetVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ParticipantRole.code.originalText",
"path": "ParticipantRole.code.originalText",
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding.",
"min": 0,
"max": "1",
"base": {
"path": "CD.originalText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id": "ParticipantRole.code.qualifier",
"path": "ParticipantRole.code.qualifier",
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code.",
"min": 0,
"max": "0",
"base": {
"path": "CD.qualifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CR"
}
]
},
{
"id": "ParticipantRole.code.translation",
"path": "ParticipantRole.code.translation",
"representation": [
"typeAttr"
],
"label": "Translation",
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min": 0,
"max": "*",
"base": {
"path": "CD.translation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CD"
}
]
},
{
"id": "ParticipantRole.addr",
"path": "ParticipantRole.addr",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.addr",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/AD"
}
]
},
{
"id": "ParticipantRole.telecom",
"path": "ParticipantRole.telecom",
"min": 0,
"max": "*",
"base": {
"path": "ParticipantRole.telecom",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/TEL"
}
]
},
{
"id": "ParticipantRole.playingDevice",
"path": "ParticipantRole.playingDevice",
"min": 0,
"max": "1",
"base": {
"path": "ParticipantRole.playingDevice",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Device"
}
]
},
{
"id": "ParticipantRole.playingEntity",
"path": "ParticipantRole.playingEntity",
"requirements": "SHALL contain exactly one [1..1] playingEntity (CONF:81-7492).",
"min": 1,
"max": "1",
"base": {
"path": "ParticipantRole.playingEntity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/PlayingEntity"
}
]
},
{
"id": "ParticipantRole.playingEntity.classCode",
"path": "ParticipantRole.playingEntity.classCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "PlayingEntity.classCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"defaultValueCode": "ENT",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityClassRoot"
}
},
{
"id": "ParticipantRole.playingEntity.determinerCode",
"path": "ParticipantRole.playingEntity.determinerCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "PlayingEntity.determinerCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"defaultValueCode": "INSTANCE",
"fixedCode": "INSTANCE",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityDeterminer"
}
},
{
"id": "ParticipantRole.playingEntity.templateId",
"path": "ParticipantRole.playingEntity.templateId",
"definition": "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min": 0,
"max": "*",
"base": {
"path": "PlayingEntity.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/II"
}
]
},
{
"id": "ParticipantRole.playingEntity.code",
"path": "ParticipantRole.playingEntity.code",
"short": "This playingEntity/code is used to supply a coded term for the drug vehicle.",
"requirements": "This playingEntity SHALL contain exactly one [1..1] code (CONF:81-7493).",
"min": 1,
"max": "1",
"base": {
"path": "PlayingEntity.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/CE"
}
],
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-EntityCode"
}
},
{
"id": "ParticipantRole.playingEntity.quantity",
"path": "ParticipantRole.playingEntity.quantity",
"min": 0,
"max": "*",
"base": {
"path": "PlayingEntity.quantity",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/PQ"
}
]
},
{
"id": "ParticipantRole.playingEntity.name",
"path": "ParticipantRole.playingEntity.name",
"requirements": "This playingEntity MAY contain zero or one [0..1] name (CONF:81-7494).",
"min": 0,
"max": "1",
"base": {
"path": "PlayingEntity.name",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/EN"
}
],
"constraint": [
{
"key": "81-10087",
"severity": "warning",
"human": "This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087)."
}
]
},
{
"id": "ParticipantRole.playingEntity.desc",
"path": "ParticipantRole.playingEntity.desc",
"min": 0,
"max": "1",
"base": {
"path": "PlayingEntity.desc",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/ED"
}
]
},
{
"id": "ParticipantRole.scopingEntity",
"path": "ParticipantRole.scopingEntity",
"min": 0,
"max": "1",
"base": {
"path": "ParticipantRole.scopingEntity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhir/cda/StructureDefinition/Entity"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ParticipantRole",
"path": "ParticipantRole"
},
{
"id": "ParticipantRole.classCode",
"path": "ParticipantRole.classCode",
"requirements": "SHALL contain exactly one [1..1] @classCode=\"MANU\" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:81-7490).",
"min": 1,
"max": "1",
"patternCode": "MANU"
},
{
"id": "ParticipantRole.templateId",
"path": "ParticipantRole.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "root"
}
],
"rules": "open"
}
},
{
"id": "ParticipantRole.templateId:primary",
"path": "ParticipantRole.templateId",
"sliceName": "primary",
"requirements": "SHALL contain exactly one [1..1] templateId (CONF:81-7495) such that it",
"min": 1,
"max": "1"
},
{
"id": "ParticipantRole.templateId:primary.root",
"path": "ParticipantRole.templateId.root",
"requirements": "SHALL contain exactly one [1..1] @root=\"2.16.840.1.113883.10.20.22.4.24\" (CONF:81-10493).",
"min": 1,
"max": "1",
"patternString": "2.16.840.1.113883.10.20.22.4.24"
},
{
"id": "ParticipantRole.code",
"path": "ParticipantRole.code",
"requirements": "SHALL contain exactly one [1..1] code (CONF:81-19137).",
"min": 1,
"max": "1"
},
{
"id": "ParticipantRole.code.code",
"path": "ParticipantRole.code.code",
"requirements": "This code SHALL contain exactly one [1..1] @code=\"412307009\" Drug Vehicle (CONF:81-19138).",
"min": 1,
"max": "1",
"patternString": "412307009"
},
{
"id": "ParticipantRole.code.codeSystem",
"path": "ParticipantRole.code.codeSystem",
"requirements": "This code SHALL contain exactly one [1..1] @codeSystem=\"2.16.840.1.113883.6.96\" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:81-26502).",
"min": 1,
"max": "1",
"patternString": "2.16.840.1.113883.6.96"
},
{
"id": "ParticipantRole.playingEntity",
"path": "ParticipantRole.playingEntity",
"requirements": "SHALL contain exactly one [1..1] playingEntity (CONF:81-7492).",
"min": 1,
"max": "1"
},
{
"id": "ParticipantRole.playingEntity.code",
"path": "ParticipantRole.playingEntity.code",
"short": "This playingEntity/code is used to supply a coded term for the drug vehicle.",
"requirements": "This playingEntity SHALL contain exactly one [1..1] code (CONF:81-7493).",
"min": 1,
"max": "1"
},
{
"id": "ParticipantRole.playingEntity.name",
"path": "ParticipantRole.playingEntity.name",
"requirements": "This playingEntity MAY contain zero or one [0..1] name (CONF:81-7494).",
"min": 0,
"max": "1",
"constraint": [
{
"key": "81-10087",
"severity": "warning",
"human": "This playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087)."
}
]
}
]
}
}
ParticipantRole 
Slices for templateId 
templateId:primary 
FHIR