CDA API Guide

cda.codeset

This module contains the most common CDA code tables, all designed to locate codes based on code descriptions. There is also ‘reverse’ table for each code set, allowing you to look up a code’s description. These features are very useful when combined with Iguana’s auto-completion feature.

Note: You can easily add code sets to this module! Simply copy the format of the existing tables. In addition, if an existing code set is incomplete, simply extend it by adding extra values to the table.

The following code tables are included:

Table Name Code Set OID
cda.codeset.cat Catalog of codeset OIDs n/a
cda.codeset.act HL7 ActCode (fhir)
HL7 ActCode (hl7.de)
2.16.840.1.113883.5.4
cda.codeset.actClass

HL7 ActClass (fhir)

HL7 ActClass (hl7.de)

2.16.840.1.113883.5.6

cda.codeset.actNoImmunization

HL7 ActReason (fhir)

HL7 ActReason (hl7.de)

2.16.840.1.113883.5.8

cda.codeset.actPriority HL7 ActPriority (fhir)
HL7 ActPriority (hl7.de)

2.16.840.1.113883.5.7

cda.codeset.address HL7 AddressUse (hl7.de) 2.16.840.1.113883.5.1119
cda.codeset.advancedDirectivesTypes HL7 Advance Directive Type (description) 2.16.840.1.113883.1.11.20.2
cda.codeset.confidentiality HL7 Confidentiality (fhir)
HL7 Confidentiality (hl7.de)

2.16.840.1.113883.5.25

cda.codeset.cpt AMA C4
AMA C4 (standard)
AMA C4 (description)(Current Procedure Terminology Evaluation and Management codes)

2.16.840.1.113883.6.12

cda.codeset.cvx CDC NCIRD CVX(Vaccines administered)

2.16.840.1.113883.12.292

cda.codeset.ethnicGroup CDCRace and Ethnicity Code Set
CDCRace and Ethnicity Code Set (description)This shares the same OID with ‘cda.codeset.race’ (they are both subsets of the full codeset).
2.16.840.1.113883.6.238
cda.codeset.healthcareServiceLocation CDC HealthcareServiceLocation

2.16.840.1.113883.6.259

cda.codeset.icf WHO ICF(International Classification of Functioning, Disability and Health)

2.16.840.1.113883.6.254

cda.codeset.interpretation HL7 ObservationInterpretation (fhir)
HL7 ObservationInterpretation (hl7.de)

2.16.840.1.113883.5.83

cda.codeset.language Internet Society RFC 4646/Library of Congress ISO 639 LanguageThere is no definitive list, but you can always create new codes:

2.16.840.1.113883.1.11.11526
cda.codeset.languageAbilityMode HL7 LanguageAbilityMode (fhir)
HL7 LanguageAbilityMode (hl7.de)

2.16.840.1.113883.5.60

cda.codeset.loinc LOINC LOINC
LOINC (description)(Logical Observation Identifiers Names and Codes)

2.16.840.1.113883.6.1

cda.codeset.marriage HL7 MaritalStatus (fhir)
HL7 MaritalStatus (hl7.de)

2.16.840.1.113883.5.2

cda.codeset.nameUses HL7 EntityNameUse

2.16.840.1.113883.5.45

cda.codeset.nci NCI Route Of Administration 2.16.840.1.113883.3.26.1.1
cda.codeset.personalRelationshipRole HL7 PersonalRelationshipRoleType

2.16.840.1.113883.1.11.19563

cda.codeset.proficiencyLevel HL7 LanguageAbilityProficiency (fhir)
HL7 LanguageAbilityProficiency (hl7.de)

2.16.840.1.113883.5.61

cda.codeset.providerCodes NUCC Health Care Provider Taxonomy

2.16.840.1.113883.6.101

cda.codeset.providerRoles HL7 Provider Role (description)

2.16.840.1.113883.12.443

cda.codeset.race CDCRace and Ethnicity Code Set
CDCRace and Ethnicity Code Set (description)This shares the same OID with ‘cda.codeset.ethnicGroup’ (they are both subsets of the full codeset).

2.16.840.1.113883.6.238

cda.codeset.religion HL7 ReligiousAffiliation

2.16.840.1.113883.5.1076

cda.codeset.roleClass HL7 RoleClass (fhir)
HL7 RoleClass (hl7.de)

2.16.840.1.113883.5.110

cda.codeset.rxnorm NLM RxNorm
NLM RxNorm (standard)
NLM RxNorm (description)

2.16.840.1.113883.6.88

cda.codeset.sex HL7 V2AdministrativeSex (description)In HL7 V3, this codeset is “replaced” by AdministrativeGender (fhir), AdministrativeGender (hl7.de)(2.16.840.1.113883.5.1) 2.16.840.1.113883.12.1
cda.codeset.signature HL7 ParticipationSignature (fhir)
HL7 ParticipationSignature (hl7.de)

2.16.840.1.113883.5.89

cda.codeset.snomedCT NIH SNOMED-CT (standard)
NIH SNOMED-CT (description)(SNOMED Controlled Terminology)

2.16.840.1.113883.6.96

cda.codeset.status HL7 ActStatus (fhir)
HL7 ActStatus (hl7.de)

2.16.840.1.113883.5.14

cda.codeset.templates* HL7 Template ID n/a

*Template IDs are common template identifiers used to specify constraints for Sections and Entries (as specifed in CDA R2). Because template identifiers are (by definition) user-definable, there is no standard list and no OID (and no corresponding entry in our module). If a list of “common templates” with an OID were to be created in the future, you could add an entry to ‘cda.codeset.cat’. For more information, check out these resources:

References

Leave A Comment?