cda.id
Contents
These functions add CDA-specific identifiers to your document:
add() [top]
Usage: cda.id.add{target=<{PARENT}>, value=<EXTENSION>, id_type=<ROOT>}
A RIM class may have an associated ID value that you will need to include in your document.
Note: Predefined root values used in the id_type argument can be found in the cda.codeset.templates table.
Returns:
- A parsed tree representing the populated XML element
Required parameters:
- target: The parent tag under which you wish to add the new element
Optional parameters:
- value: The extension (or specific value) of the ID
- id_type: The root identifier (object ID) of the desired ID
Example:
cda.id.add{target={PARENT}, value='998991', id_type=cda.codeset.cat.HL7ExampleOid}
Example Result:
<id extension="998991" root="2.16.840.1.113883.19.5.99999.2"></id>
template.add() [top]
Usage: cda.id.template.add{target=<{PARENT}>, value=<EXTENSION>, id_type=<ROOT>}
CDA documents are made up of a collection of templates that describe a particular actor or event. Every template has an associated template ID.
Note: Predefined root values used in the id_type argument can be found in the cda.codeset.templates table.
Returns:
- A parsed tree representing the populated XML element
Required parameters:
- target: The parent tag under which you wish to add the new element. The templateID tag is inserted into position 1.
- id_type: The root identifier (object ID) of the desired ID
Optional parameters:
- value: The extension (or specific value) of the ID
Example:
cda.id.template.add{target={PARENT}, id_type=cda.codeset.templates.Assessment}
Example Result:
<templateId root="2.16.840.1.113883.10.20.22.2.8"></templateId>