This is the set of resources that conform to both Planned Immunization Activity (http://hl7.org/cda/us/ccda/StructureDefinition/PlannedImmunizationActivity) and Planned Immunization Activity (http://hl7.org/cda/us/ccda/StructureDefinition/PlannedImmunizationActivity).
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubstanceAdministration | C | 1..1 | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value | |
nullFlavor | 0..1 | ??, ?? | Binding: ?? (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
nullFlavor | 0..1 | ??, ?? | Binding: ?? (required) | |
assigningAuthorityName | 0..1 | ??, ?? | ||
displayable | 0..1 | ??, ?? | ||
root | 1..1 | ??, ??, ??, ?? | ||
extension | 1..1 | ??, ?? | ||
templateId | 1..* | II | ||
classCode | 1..1 | ??, ?? | Binding: ?? (required) | |
moodCode | 1..1 | ??, ?? | Binding: ?? (required) | |
code | 0..1 | CD | Binding: ?? (example) | |
negationInd | 0..1 | ??, ?? | ||
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
nullFlavor | 0..1 | ??, ?? | Binding: ?? (required) | |
compression | 0..1 | ??, ?? | Binding: ?? (required) | |
integrityCheck | 0..1 | ??, ?? | ||
integrityCheckAlgorithm | 0..1 | ??, ?? | Binding: ?? (required) | |
language | 0..1 | ??, ?? | ||
mediaType | 0..1 | ??, ?? | Binding: ?? (example) | |
representation | 0..1 | ??, ?? | Binding: ?? (required) | |
xmlText | 0..1 | ??, ?? | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
thumbnail | 0..1 | ED | ||
statusCode | 1..1 | CS | Binding: ?? (required) | |
nullFlavor | 0..1 | ??, ?? | Binding: ?? (required) | |
code | 1..1 | ??, ?? | ||
sdtcValueSet | 0..1 | ??, ?? | ||
sdtcValueSetVersion | 0..1 | ??, ?? | ||
effectiveTime | 1..1 | The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur. | ||
effectiveTime | SXCM_TS | |||
effectiveTime | IVL_TS | |||
effectiveTime | EIVL_TS | |||
effectiveTime | PIVL_TS | |||
effectiveTime | SXPR_TS | |||
priorityCode | 0..1 | CE | Binding: ?? (example) | |
repeatNumber | 0..1 | IVL_INT | In a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. | |
routeCode | C | 0..1 | CE | Binding: ?? (required) should-translation: SHOULD contain translation |
nullFlavor | 0..1 | ??, ?? | Binding: ?? (required) | |
code | 0..1 | ??, ?? | ||
codeSystem | 0..1 | ??, ??, ??, ?? | ||
codeSystemName | 0..1 | ??, ?? | ||
codeSystemVersion | 0..1 | ??, ?? | ||
displayName | 0..1 | ??, ?? | ||
sdtcValueSet | 0..1 | ??, ?? | ||
sdtcValueSetVersion | 0..1 | ??, ?? | ||
originalText | 0..1 | ED | ||
translation | 0..* | CD | Binding: ?? (required) | |
approachSiteCode | 0..* | CD | Binding: ?? (required) | |
doseQuantity | C | 0..1 | IVL_PQ | should-unit: SHOULD contain @unit |
nullFlavor | 0..1 | ??, ?? | Binding: ?? (required) | |
unit | 0..1 | ??, ?? | NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units Binding: ?? (required) | |
value | 0..1 | ??, ?? | ||
translation | 0..* | PQR | ||
operator | 0..1 | ??, ?? | Binding: ?? (required) | |
low | 0..1 | IVXB_PQ | ||
center | 0..1 | PQ | ||
width | 0..1 | PQ | ||
high | 0..1 | IVXB_PQ | ||
rateQuantity | 0..1 | IVL_PQ | ||
maxDoseQuantity | 0..1 | RTO_PQ_PQ | ||
administrationUnitCode | 0..1 | CE | Binding: ?? (example) | |
consumable | 1..1 | InfrastructureRoot | ||
nullFlavor | 0..1 | ??, ?? | Binding: ?? (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
nullFlavor | 0..1 | ??, ?? | Binding: ?? (required) | |
assigningAuthorityName | 0..1 | ??, ?? | ||
displayable | 0..1 | ??, ?? | ||
root | 1..1 | ??, ??, ??, ?? | ||
extension | 1..1 | ??, ?? | ||
templateId | 0..* | II | ||
typeCode | 0..1 | ??, ?? | Binding: ?? (required) | |
manufacturedProduct | C | 1..1 | ??, ?? | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) should-manufacturerOrganization: SHOULD contain manufacturerOrganization |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | ||
performer | 0..* | Performer2 | The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer. | |
author | 0..* | ??, ?? | The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity. | |
informant | 0..* | Informant | ||
participant | 0..* | Participant2 | ||
entryRelationship | 0..* | EntryRelationship | The following entryRelationship captures any instructions associated with the planned immunization activity. | |
reference | 0..* | Reference | ||
precondition | 0..* | Precondition | ||
sdtcInFulfillmentOf1 | 0..* | InFulfillmentOf1 | ||
Documentation for this format |