International Patient Summary 1.0.0 Release
1.0 - CI Build

International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions

Resource Profile: IPSImmunizationMedicationInformation - Detailed Descriptions

Draft as of 2017-03-08

Definitions for the 2.16.840.1.113883.10.22.4.16--20170308000000 resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. ManufacturedProduct
Control1..*1
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ManufacturedProduct.classCode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. ManufacturedProduct.templateId
SlicingThis element introduces a set of slices on ManufacturedProduct.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
4. ManufacturedProduct.templateId:primary
SliceNameprimary
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
5. ManufacturedProduct.templateId:primary.root
Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.10.22.4.16
6. ManufacturedProduct.manufacturedMaterial
Control10..1
Must Supporttrue
7. ManufacturedProduct.manufacturedMaterial.code
Control1..1
BindingThe codes SHOULD be taken from IPS Vaccines IPS Vaccine
Must Supporttrue
8. ManufacturedProduct.manufacturedMaterial.code.translation
Control0..*
9. ManufacturedProduct.manufacturedMaterial.lotNumberText
Control0..1
10. ManufacturedProduct.manufacturerOrganization
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here.

1. ManufacturedProduct
Definition

Base definition for all types defined in FHIR type system.

Control0..*
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ManufacturedProduct.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassManufacturedProduct
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueMANU
Fixed ValueMANU
3. ManufacturedProduct.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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on ManufacturedProduct.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
4. ManufacturedProduct.templateId:primary
SliceNameprimary
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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
5. ManufacturedProduct.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.10.22.4.16
6. ManufacturedProduct.manufacturedMaterial
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Material
Must Supporttrue
7. ManufacturedProduct.manufacturedMaterial.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassManufacturedMaterial
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueMMAT
Fixed ValueMMAT
8. ManufacturedProduct.manufacturedMaterial.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminerDetermined
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueKIND
Fixed ValueKIND
9. ManufacturedProduct.manufacturedMaterial.code
Control1..1
BindingThe codes SHOULD be taken from IPS Vaccines IPS Vaccine
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Must Supporttrue
10. ManufacturedProduct.manufacturedMaterial.code.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
11. ManufacturedProduct.manufacturedMaterial.code.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
12. ManufacturedProduct.manufacturedMaterial.lotNumberText
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
13. ManufacturedProduct.manufacturerOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here.

1. ManufacturedProduct
Definition

Base definition for all types defined in FHIR type system.

Control0..*
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ManufacturedProduct.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassManufacturedProduct
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueMANU
Fixed ValueMANU
3. ManufacturedProduct.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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on ManufacturedProduct.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ root,
4. ManufacturedProduct.templateId:primary
SliceNameprimary
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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
5. ManufacturedProduct.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
6. ManufacturedProduct.templateId:primary.assigningAuthorityName
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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
7. ManufacturedProduct.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
8. ManufacturedProduct.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.10.22.4.16
9. ManufacturedProduct.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
10. ManufacturedProduct.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
11. ManufacturedProduct.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
12. ManufacturedProduct.manufacturedLabeledDrug
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/LabeledDrug
13. ManufacturedProduct.manufacturedMaterial
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Material
Must Supporttrue
14. ManufacturedProduct.manufacturedMaterial.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassManufacturedMaterial
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueMMAT
Fixed ValueMMAT
15. ManufacturedProduct.manufacturedMaterial.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminerDetermined
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueKIND
Fixed ValueKIND
16. ManufacturedProduct.manufacturedMaterial.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
17. ManufacturedProduct.manufacturedMaterial.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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
18. ManufacturedProduct.manufacturedMaterial.code
Control1..1
BindingThe codes SHOULD be taken from IPS Vaccines IPS Vaccine
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Must Supporttrue
19. ManufacturedProduct.manufacturedMaterial.code.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
20. ManufacturedProduct.manufacturedMaterial.code.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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
21. ManufacturedProduct.manufacturedMaterial.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
22. ManufacturedProduct.manufacturedMaterial.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
23. ManufacturedProduct.manufacturedMaterial.code.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
24. ManufacturedProduct.manufacturedMaterial.code.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
25. ManufacturedProduct.manufacturedMaterial.code.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
26. ManufacturedProduct.manufacturedMaterial.code.sdtcValueSetVersion
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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
27. ManufacturedProduct.manufacturedMaterial.code.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
28. ManufacturedProduct.manufacturedMaterial.code.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
29. ManufacturedProduct.manufacturedMaterial.code.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
30. ManufacturedProduct.manufacturedMaterial.name
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
31. ManufacturedProduct.manufacturedMaterial.lotNumberText
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
32. ManufacturedProduct.manufacturerOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Must Supporttrue