Name | Source | Ver | Description |
Admission Diagnosis Section | hl7.cda.us.ccda#current | R5 | This section contains a narrative description of the problems or diagnoses identified by the clinician at the time of the patient's admission. This section may contain a coded entry which represents the admitting diagnoses. |
Admission Medication | hl7.cda.us.ccda#current | R5 | This template represents the medications taken by the patient prior to and at the time of admission. |
Admission Medications Section (entries optional) | hl7.cda.us.ccda#current | R5 | The section contains the medications taken by the patient prior to and at the time of admission to the facility. |
Advance Directive Observation | hl7.cda.us.ccda#current | R5 | This clinical statement represents Advance Directive Observation findings (e.g., "resuscitation status is Full Code") rather than orders. It should not be considered a legal document or a substitute for the actual Advance Directive document. The related legal documents are referenced using the reference/externalReference element. The Advance Directive Observation describes the patient's directives, including but not limited to: * Medications * Transfer of Care to Hospital * Treatment * Procedures * Intubation and Ventilation * Diagnostic Tests * Tests The observation/value element contains the detailed patient directive which may be coded or text. For example, a category directive may be antibiotics, and the details would be intravenous antibiotics only. |
Advance Directive Organizer | hl7.cda.us.ccda#current | R5 | This clinical statement groups a set of advance directive observations. |
Advance Directives Section | hl7.cda.us.ccda#current | R5 | This section contains data defining the patient's advance directives and any reference to supporting documentation, including living wills, healthcare proxies, and CPR and resuscitation status. If the referenced documents are available, they can be included in the exchange package. The most recent directives are required, if known, and should be listed in as much detail as possible. This section differentiates between "advance directives" and "advance directive documents". The former is the directions to be followed whereas the latter refers to a legal document containing those directions. |
Age Observation | hl7.cda.us.ccda#current | R5 | This Age Observation represents the subject's age at onset of an event or observation. The age of a relative in a Family History Observation at the time of that observation could also be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime. However, a common scenario is that a patient will know the age of a relative when the relative had a certain condition or when the relative died, but will not know the actual year (e.g., "grandpa died of a heart attack at the age of 50"). Often times, neither precise dates nor ages are known (e.g., "cousin died of congenital heart disease as an infant"). |
Allergies and Intolerances Section | hl7.cda.us.ccda#current | R5 | This section lists and describes any medication allergies, adverse reactions, idiosyncratic reactions, anaphylaxis/anaphylactoid reactions to food items, and metabolic variations or adverse reactions/allergies to other substances (such as latex, iodine, tape adhesives). At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. |
Allergy - Intolerance Observation | hl7.cda.us.ccda#current | R5 | This template reflects a discrete observation about a patient's allergy or intolerance. Because it is a discrete observation, it will have a statusCode of "completed". The effectiveTime, also referred to as the "biologically relevant time" is the time at which the observation holds for the patient. For a provider seeing a patient in the clinic today, observing a history of penicillin allergy that developed five years ago, the effectiveTime is five years ago. The effectiveTime of the Allergy - Intolerance Observation is the definitive indication of whether or not the underlying allergy/intolerance is resolved. If known to be resolved, then an effectiveTime/high would be present. If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of "UNK". The agent responsible for an allergy or adverse reaction is not always a manufactured material (for example, food allergies), nor is it necessarily consumed. The following constraints reflect limitations in the base CDA R2 specification, and should be used to represent any type of responsible agent, i.e., use playingEntity classCode = "MMAT" for all agents, manufactured or not. |
Allergy Concern Act | hl7.cda.us.ccda#current | R5 | This template reflects an ongoing concern on behalf of the provider that placed the allergy on a patient's allergy list. As long as the underlying condition is of concern to the provider (i.e., as long as the allergy, whether active or resolved, is of ongoing concern and interest to the provider), the statusCode is "active". Only when the underlying allergy is no longer of concern is the statusCode set to "completed". The effectiveTime reflects the time that the underlying allergy was felt to be a concern. The statusCode of the Allergy Concern Act is the definitive indication of the status of the concern, whereas the effectiveTime of the nested Allergy - Intolerance Observation is the definitive indication of whether or not the underlying allergy is resolved. The effectiveTime/low of the Allergy Concern Act asserts when the concern became active. This equates to the time the concern was authored in the patient's chart. The effectiveTime/high asserts when the concern was completed (e.g., when the clinician deemed there is no longer any need to track the underlying condition). |
Allergy Status Observation | hl7.cda.us.ccda#current | R5 | This template represents the clinical status attributed to the allergy or intolerance. There can be only one allergy status observation per allergy - intolerance observation. |
Anesthesia Section | hl7.cda.us.ccda#current | R5 | The Anesthesia Section records the type of anesthesia (e.g., general or local) and may state the actual agent used. This may be a subsection of the Procedure Description Section. The full details of anesthesia are usually found in a separate Anesthesia Note. |
Assessment and Plan Section | hl7.cda.us.ccda#current | R5 | This section represents the clinician's conclusions and working assumptions that will guide treatment of the patient. The Assessment and Plan Section may be combined or separated to meet local policy requirements. See also the Assessment Section: templateId 2.16.840.1.113883.10.20.22.2.8 and Plan of Treatment Section (V2): templateId 2.16.840.1.113883.10.20.22.2.10:2014-06-09 |
Assessment Scale Observation (V2) | hl7.cda.us.ccda#current | R5 | An assessment scale is a collection of observations that together can yield a calculated or non-calculated summary evaluation of a one or more conditions. Examples include the Braden Scale (assesses pressure ulcer risk), APACHE Score (estimates mortality in critically ill patients), Mini-Mental Status Exam (assesses cognitive function), APGAR Score (assesses the health of a newborn), Glasgow Coma Scale (assesses coma and impaired consciousness), and WE CARE (Well Child Care, Evaluation, Community Resources, Advocacy, Referral, Education - a clinic-based screening and referral system developed for pediatric settings). When an Assessment Scale Observation is contained in a Problem Observation, a Social History Observation or a Procedure instance that is Social Determinant of Health focused, that Assessment scale **MAY** contain assessment scale observations that represent question and answer pairs from SDOH screening instruments that are represented in LOINC. Note that guidance on the use of LOINC in assessment scales already exists in Assessment Scale Observation constraints and Assessment Scale Supporting Observations constraints. |
Assessment Scale Supporting Observation (V2) | hl7.cda.us.ccda#current | R5 | An Assessment Scale Supporting Observation represents the components of a scale used in an Assessment Scale Observation. The individual parts that make up the component may be a group of physical, cognitive, functional status, social observations or answers to questions. |
Assessment Section | hl7.cda.us.ccda#current | R5 | The Assessment Section (also referred to as "impression" or "diagnoses" outside of the context of CDA) represents the clinician's conclusions and working assumptions that will guide treatment of the patient. The assessment may be a list of specific disease entities or a narrative block. |
Author Participation | hl7.cda.us.ccda#current | R5 | This template represents the Author Participation (including the author timestamp). CDA R2 requires that Author and Author timestamp be asserted in the document header. From there, authorship propagates to contained sections and contained entries, unless explicitly overridden. The Author Participation template was added to those templates in scope for analysis in R2. Although it is not explicitly stated in all templates the Author Participation template can be used in any template. |
Authorization Activity | hl7.cda.us.ccda#current | R5 | An Authorization Activity represents authorizations or pre-authorizations currently active for the patient for the particular payer. Authorizations are represented using an act subordinate to the policy or program that provided it. The authorization refers to the policy or program. Authorized treatments can be grouped into an organizer class, where common properties, such as the reason for the authorization, can be expressed. Subordinate acts represent what was authorized. |
Basic Industry Observation | hl7.cda.us.ccda#current | R5 | This template represents a simple observation about the type of business that compensates for work or assigns work to an unpaid worker or volunteer (e.g., U.S. Army, cement manufacturing, children and youth services). Multiple occupation industry observation instances in a single document or derived from multiple documents, represent a basic historical industry record. Implementers should use the Basic Industry Observation template for conveying Industry in support of USCDI v3. It is recommended systems include the Basic Industry Observation in the Social History section. Implementers wishing to convey more advanced Industry detail may consider using [HL7 CDA R2 Implementation Guide: C-CDA R2.1 Supplemental Templates for Occupational Data for Health](https://www.hl7.org/implement/standards/product_brief.cfm?product_id=522) in addition to this Observation. |
Basic Occupation Observation | hl7.cda.us.ccda#current | R5 | This template represents a simple observation about the type of work (e.g., infantry, business analyst, social worker) of a person. The effectiveTime low and high represent the start and end times of a particular observation about an occupation. Multiple occupation observation instances in a single document or derived from multiple documents, represent a basic historical occupation record. Implementers should use the Basic Occupation Observation template for conveying occupation information in support of USCDI v3. It is recommended systems include the Basic Industry Observation in the Social History section. Implementers wishing to convey more advanced Occupation detail, such as employer, usual work (longest held), or other work related observations may consider using [HL7 CDA R2 Implementation Guide: C-CDA R2.1 Supplemental Templates for Occupational Data for Health](https://www.hl7.org/implement/standards/product_brief.cfm?product_id=522) in addition to this Observation. |
BC Abatement Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The end, remission or resolution. |
BC AccessionIdentifier Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Identifier assigned by the lab |
BC ActiveFlag Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI. |
BC ActiveFlagAsaCodeableConcept Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI. |
BC Actual Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | True if the group is an actual group (as opposed to definitional). |
BC Additive Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Additive associated with container. |
BC Address Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. (Source: HL7 FHIR). |
BC AddressLine Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Part of an address that contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. (Source: HL7 FHIR). |
BC AdministrativeGender Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A gender classification used for administrative purposes. Administrative gender is not necessarily the same as a biological description or a gender identity. This attribute does not include terms related to clinical gender. |
BC Age Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | How long someone has been alive, or something has existed. |
BC AlleviatingFactor Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Activities that reduce the severity of the pathology |
BC AnatomicalDirection Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Anatomical location or specimen further detailing directionality. |
BC AnatomicalLocation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A location or structure in the body, including tissues, regions, cavities, and spaces; for example, right elbow, or left ventricle of the heart. |
BC ApplicableAgeRange Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. |
BC ApplicableSubpopulation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. |
BC AssertionContext Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The parent class of contexts that can associate with AssertionTopic and its subclasses. |
BC AssertionPresenceStatement Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Statement that a finding is present. |
BC AssertionStatement Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A clinical statement that asserts presence or absence. |
BC AssertionTopic Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The base topic for conditions, allergies, adverse events, etc. These are things asserted to exist or not. The Value is interpreted in the context of the class; for an AdverseSensitivityToSubstance, the TopicCode is the substance, for a Condition, the TopicCode represents the type of condition found. |
BC AverageCEP17SignalsPerCell Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Average number CEP17 signals per cell (dual probe only) |
BC AverageHER2SignalsPerCell Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Average number of HER2 signals per cell |
BC BinaryData Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The data itself. |
BC Brand Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | If the product is branded, and if so, the brand name of a product. |
BC BrandName Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The marketing name for a brand name product |
BC BRCA1Variant Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Whether the patient has a mutation in the BRCA1 gene. |
BC BRCA2Variant Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Whether the patient has a mutation in the BRCA2 gene. |
BC BreastCancerDistantMetastasesClassification Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The presence of distant metastases, based on criteria defined by the staging system being used. |
BC BreastCancerGeneticAnalysisObservation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The status of genes known or suspected to play a role in breast cancer risk, for example, the tumor suppressor genes, BRCA1 and BRCA2. |
BC BreastCancerHistologicGrade Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The Elston Grade/Nottingham Score, representative of the aggressive potential of the tumor. Well differentiated cells (Grade 1) look similar to normal cells and are usually slow growing, while poorly differentiated cells (Grade 3) look very different than normal and are fast-growing. |
BC BreastCancerPresenceStatement Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Diagnosis of cancer originating in the tissues of the breast, and potentially spread to other organs of the body. |
BC BreastCancerPrimaryTumorClassification Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The size and extent of the primary tumor, based on criteria defined by the staging system being used. |
BC BreastCancerRegionalNodesClassification Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The presence of metastases in regional lymph nodes, based on criteria defined by the staging system being used. |
BC BreastCancerStage Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The stage of a breast cancer. Different staging systems use different staging groups, so there are currently no terminology bindings associated with this class. |
BC BreastCancerStageTopic Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The topic class for describing a breast cancer staging observation. |
BC BreastClinicalLymphNodeInvolvement Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Clinical assessment of lymph nodes for presence of cancer cells in staging the N category in cancers. |
BC BreastLymphNodeBodySite Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A body site specific to the lymph node structure. |
BC BreastLymphNodeInvolvement Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Identification of whether tumor cells have extended to the lymph nodes. Formerly known as BreastNodeInvolvementValues |
BC BreastPathologicalLymphNodeInvolvement Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Clinical assessment of lymph nodes for presence of cancer cells in staging the N category in cancers. |
BC BreastSite Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A body site specific to the breast structure. |
BC BreastSpecimen Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Specimen resulting from biopsy or excision of breast and surrounding tissue. |
BC BreastTumor Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An abnormal mass of tissue that results when cells divide more than they should or do not die when they should. Tumors may be benign (not cancer), or malignant (cancer). Also called neoplasm. (source: NCI) |
BC Capacity Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Container volume or size. |
BC Category Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A class or division of people or things having particular shared characteristics |
BC Certainty Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The degree of confidence in a conclusion or assertion. |
BC City Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The name of a municipality, city, town, village or other community or delivery center. (Source: HL7 FHIR). |
BC ClinicalStatement Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A special type of information entry consisting of a topic and a context. The ClinicalStatement class provides the core pattern for more specific clinical statement classes, such as a statement that a finding has been found in a patient or that a procedure has been proposed by a clinical decision support system. The ClinicalStatement pattern defines the core attributes common to most clinical statements and specifies a composition pattern that encourage model component reuse and better alignment with the SNOMED CT Concept Model. A clinical statement is composed of the StatementTopic class (grouping of attributes for capturing information about a procedure or a clinical finding) and the StatementContext class (grouping of attributes providing the context for the statement topic such as whether a procedure was performed, requested, not performed or whether a finding is suspected present or absent in the patient). At the archetype level, the topic and context components are coordinated to form the clinical statement. For instance, the composition of the ProcedureTopic with the NotPerformed context indicates that the given procedure was not performed. |
BC ClinicalStatus Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A flag indicating whether the condition is active or inactive, recurring, in remission, or resolved (as of the last update of the Condition). |
BC ClockDirection Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A direction indicated by an angle relative to 12 o'clock. |
BC CodedEvaluationComponent Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An evaluation component whose value is a code (concept). |
BC CodedLaboratoryObservation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A coded finding from a laboratory test. |
BC CodeSystem Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A formal terminology system. |
BC CodeSystemVersion Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The version of the vocabulary being used, if applicable. |
BC ColdIschemiaTime Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The time period between the chilling of a tissue or tissue sample and the time it is warmed. CIMI Alignment: In CIMI Version 0.0.4, specimen processing is represented as a 'SpecimenProcessingPerformed' clinical statement, mapped to FHIR Procedure. However, specimen processing maps to FHIR Specimen.processing, part of the Specimen resource. It would be a difficult mapping exercise (and beyond the scope of this IG) to express the mapping rule that any CIMI SpecimenProcessingPerformed clinical statement needs to mapped to FHIR by (1) finding the corresponding Specimen entity, and (2) mapping the content of (possibly multiple) SpecimenProcessingPerformed into the FHIR Specimen resource. To avoid this complexity, the breast cancer model expresses the cold ischemia time as an attribute of the BreastSpecimen rather than a separate procedure. |
BC CollectionMethod Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | How the specimen was obtained. |
BC CollectionSite Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The body site where specimen was collected |
BC CollectionSource Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The person or thing the sample was obtained from. |
BC CollectionTime Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | When the sample was obtained, as a specific time or time period. |
BC Comparator Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | |
BC CompleteMembraneStainingPercent Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Percentage of cells with uniform intense complete membrane staining. |
BC ComponentOnlyNonLaboratoryObservation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An observation with components, but without a result value or panel members. |
BC ConditionAssertionTopic Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A condition, independent of context. 'Condition' is interpreted broadly to include disorder, abnormality, problem, injury, complaint, functionality, concern, illness, disease, ailment, sickness, affliction, upset, difficulty, disorder, symptom, worry, or trouble, independent of context. |
BC ConditionCause Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The cause of the condition. This includes such causes as disease vectors and endogenous states (e.g., macular degeneration due to diabetes), substances, medications, micro-organisms, and forces associated with the occurrence of a Condition from temporal or causative perspectives |
BC ConditionPresenceContext Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The context for a condition that is known, suspected, or possibly present. |
BC ConditionPresenceStatement Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A condition that is or may be present in a subject. 'Condition' is interpreted broadly and could be a disorder, abnormality, problem, injury, complaint, functionality, illness, disease, ailment, sickness, affliction, upset, difficulty, disorder, symptom, worry, or trouble. |
BC ContactPoint Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An electronic means of contacting an organization or individual. |
BC Content Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Abstract ancestor of all concrete content types. A unit of content that makes up a composition - e.g., a clinical statement in a patient record, a simple or composite action is a knowledge document, a catalog entry in a catalog. |
BC ContentType Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Mime type of the content, with charset etc. |
BC ContextCode Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A code representing the ontological status of the statement, e.g., whether it exists, does not exist, is planned, etc. Attribute aligns with the SNOMED CT Situation with Explicit Context (SWEC) Concept Model context attributes: 'Finding context (attribute)' (SCTID: 408729009) and 'Procedure context (attribute)' (SCTID: 408730004). The range allowed for this attribute shall be consistent with the SNOMED CT concept model specification for SWEC. |
BC Count Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The number of items (0 or more), as an integer. |
BC Country Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Country - a nation as commonly understood or generally accepted, expressed in ISO 3166 Alpha-2 (2-letter) codes. |
BC CreationTime Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The point in time when the information was recorded in the system of record. |
BC DateOfBirth Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A date of birth or approximate year or period (year or date range), if estimated. |
BC DCISNuclearGrade Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An evaluation of the size and shape of the nucleus in tumor cells and the percentage of tumor cells that are in the process of dividing or growing. Cancers with low nuclear grade grow and spread less quickly than cancers with high nuclear grade. In breast cancer, nuclear grade is typically evaluated for ductal carcinoma in situ (DCIS) only. There is currently no concept code for DCIS Nuclear Grade in LOINC, SNOMED, or NCI Metathesaurus. |
BC DeltaFlag Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Indicator of significant change (delta) from the last or previous measurement. |
BC Denominator Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The divisor of a fraction. |
BC Details Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A text note containing additional details, explanation, description, comment, or summarization. Details can discuss, support, explain changes to, or dispute information. |
BC Device Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A specific durable physical device used in diagnosis or treatment. The value is the coding for a type of device, for example, a CPAP machine. The same device might be used on multiple patients. |
BC DeviceUdi Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Unique Device Identifier (UDI) Barcode string number for a device, assigned by the organization using the device. |
BC DiagnosticService Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The service completing the observations, e.g. biochemistry, microbiology, blood bank. |
BC DisplayText Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A string meant for reading by a person, for example, accompanying a code. |
BC DistanceFromBreastSiteToNipple Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Distance between the feature of interest (e.g., the tumor) and the nipple. |
BC District Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The name of the administrative area at a level below that of a state but above that of a city or town. In the US, a county. Outside the US, a district or the equivalent. (Source: HL7 FHIR). |
BC DoseForm Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The form in which active and/or inert ingredient(s) are physically presented. |
BC EffectiveTimePeriod Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The date and time span for which something is active, valid, or in force. |
BC EmbeddedContent Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Abstract class defining the common metadata of all types of encapsulated data, such as images. |
BC Encounter Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. |
BC EncounterType Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). |
BC Entity Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Root class for entities such as people, organizations, and devices that have a separately identifiable existence. |
BC EntityOrRole Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Parent class entity and role. |
BC EstrogenReceptorAverageStainingIntensity Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The degree or magnitude of staining across positively stained tumor cells on the entire tissue section relative to the intensity of positive controls run with the same batch. |
BC EstrogenReceptorNuclearPositivity Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The percentage of cells that test (stain) positive for the presence of estrogen receptors. We are seeking feedback on whether nuclear positivity should be an exact percentage or a range of percentages. As currently defined, an exact nuclear positivity could be represented by a zero-width range, where the lower and upper bounds would be the same number. |
BC EstrogenReceptorStatus Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Estrogen receptor alpha is the predominant estrogen receptor expressed in breast tissue and is overexpressed in around 50% of breast carcinomas. ER status (positive=present or overexpressed; negative=absent) is a factor in determining prognosis and treatment options. The current approach is that positive/negative designation is a value, even though that value is (in fact) an interpretation of evidence (NuclearPositivity and AverageStainingIntensity). |
BC EvaluationComponent Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A simplified, non-separable evaluation consisting of a finding code (represented by the Concept), value (or exception value), reference range, and interpretation. The subject of the evaluation component is the same as in the parent evaluation. |
BC ExacerbatingFactor Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Activities that increase the severity of the pathology |
BC ExceptionValue Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Reason that a value associated with a test or other finding is missing. |
BC ExcludeFlag Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | If true, exclude the subjects that match the criterion. |
BC ExpirationDate Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | When the item (medication, device, etc.) will expire. |
BC ExtraCapsularExtensionOfNodalTumorStatus Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Status for presence of extranodal extension of carcinoma where extranodal extension is the perforation of a cancer through the capsule of a lymph node into the tissue surrounding the node. |
BC FamilyName Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The portion of a person's name that reflects the genealogy of the person. In western cultures, this is the 'last' name. In eastern cultures, the family name appears before the person's given name(s). In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. (Source: HL7 V3). |
BC FindingContext Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The base class for representing the ontological status of a finding, e.g., present, absent, goal, risk, expectation, etc. This class aligns with the SNOMED Situation with Explicit Context. |
BC FindingMethod Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The technique used to create the finding, for example, the specific imaging technical, lab test code, or assessment vehicle. |
BC FindingSiteConditionPresenceStatement Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Presence of a distinct anatomical or pathological morphological feature or organizational pattern, acquired or innate. Examples include tissue types, tumors, and wounds. Body structures are continuants that allow observations of the same body structure to be related to be tracked over time. |
BC FindingSiteConditionTopic Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Presence (or absence) of a distinct anatomical or pathological morphological feature or organizational pattern, acquired or innate. Examples include tissue types, tumors, and wounds. The FindingSiteCondition topic provides not only the AnatomicalLocation (as in CIMI FindingSiteAssertionTopic), tbut also the type of structure found at that location, such as a wound or tumor. |
BC FindingSiteIdentifier Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A human-readable identifier for the condition at the finding site, for example, a wound number or tumor identifier. |
BC FindingStatement Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Any clinical statement representing a finding. |
BC FindingStatus Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Indicates whether the finding is preliminary, amended, final, etc. |
BC FindingTopic Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Base class - independent of context - for all kinds of determinations: questions/answers, conditions, observations, allergies, and other findings. The subject of a finding can be the entire patient, or an entity such as a location body structure, intervention, or condition. Things observed about the subject can include social and behavioral factors, subjective and objective observations, and assessments. |
BC GeopoliticalLocation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The countries of the world and major geopolitical subregions, such as US states. |
BC GivenName Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The person's given name - e.g., John |
BC Group Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A set of entities (personnel, material, or places) to be considered together. May be a pool of like-type resources, a team, or combination of personnel, material and places. |
BC GroupCharacteristic Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An inclusion or exclusion criterion as part of defining a cohort. If the criterion is an unary, then TopicCode must be SCT#385432009 (not applicable) |
BC GroupCharacteristicCode Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A code describing the characteristic present, absent, or having a value in this group. |
BC HandlingRisk Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Cautions on the handling of this specimen. |
BC Hash Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A hash code of the data (sha-1, base64ed) |
BC Headshot Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A photograph showing a person's face. |
BC HER2byFISH Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | HER2 receptor status as determined by single-probe or dual-probe Fluorescence In Situ Hybridization (FISH). |
BC HER2byIHC Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | HER2 presence in Breast cancer specimen by Immunohistochemistry (IHC). |
BC HER2ReceptorStatus Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | HER2 receptor status. HER2 is a member of the human epidermal growth factor receptor family of proteins and is encoded by the ERBB2 oncogene. HER2 is overexpressed in 20-30% of breast tumors, and is associated with an aggressive clinical course and poor prognosis. HER2 status (positive=present or overexpressed; negative=absent) is a factor in determining prognosis and treatment options. |
BC HER2toCEP17Ratio Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | HER2 to CEP17 Ratio (dual probe only) |
BC HumanName Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The CIMI person name, constrained to map correctly to FHIR. |
BC Identifier Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A unique string that identifies a specific person or thing. |
BC Independent Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Base class for classes in CIMI that include enough context to stand alone. Analogous to FHIR's DomainResource. |
BC InformationEntry Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An entry in a patient record or in a report, generally used for the documentation of clinical information about a subject of information such as a patient or a relative of the patient, asserted by a particular source, recorded, and potentially verified. |
BC Ingredient Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Specifies an material component in a non-medication substance. |
BC IngredientAmount Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The amount of an ingredient in a mixture, as a ratio. For example, 250 mg per tablet is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. |
BC IntegerQuantity Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A Quantity that is an integer. |
BC Interpretation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A clinical interpretation of a finding (applies to both assertions and observation). |
BC IsActiveIngredient Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | True if the ingredient is an active ingredient in the medication. |
BC Issued Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The date and time this observation was made available to providers, typically after the results have been reviewed and verified. |
BC Issuer Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An organization who issues a qualification, identifier, or license. |
BC Ki-67NuclearAntigen Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Ki-67 is a protein phosphatase whose expression is strongly associated with cell proliferation and encoded by the MKI67 gene. The Ki67 labeling index is the fraction of Ki-67-positive cells to total cells in a tumor specimen and may be useful for determining prognosis with respect to survival and disease recurrence. The Ki-67 antigen is measured numerically as a percentage, and as an ordinal. The more positive cells there are, the more quickly they are dividing and forming new cells. ReferenceRange: Low <10, Intermediate 10-20, >20 High. |
BC Ki-67NuclearAntigenValue Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Ki-67 is a protein phosphatase whose expression is strongly associated with cell proliferation and encoded by the MKI67 gene. The Ki-67 antigen is measured quantitatively as a percentage. |
BC LaboratoryObservation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A coded finding based on a specimen collected from a patient. |
BC LaboratoryObservationTopic Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The topic composition for laboratory observations. A specimen is required, anatomical location is excluded (since the specimen indicates the collection body site). Also includes a diagnostic service (indicating the type of laboratory), not present in general observations. |
BC Language Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A human language, spoken or written. |
BC LanguageQualifier Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Additional information about a person's use of language. |
BC LanguageUsed Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Language used for communication by a human, either the subject of record, parent, or other involved person. |
BC Laterality Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Anatomical location or specimen further detailing the side(s) of interest. |
BC Locatable Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Abstract top level class in the CIMI hierarchy. The Locatable class reflects CIMI's implementation using Archetype Description Language (ADL). Its attributes (archetype_node_id, name, and archetype_details) are necessary to serialize CIMI definitions in ADL, but have no clinical relevance. To avoid complicating the profiles with irrelevant extensions, the attributes of Locatable have been omitted. |
BC LotNumber Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A distinctive alpha-numeric identification code assigned by the manufacturer or distributor to a specific quantity of manufactured material or product within a batch. |
BC LowerBound Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The lower limit on a range |
BC LymphNodeMobility Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Lymph node palpable |
BC LymphNodeSamplingMethod Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The procedure method used to obtain the specimen analyzed for the pathological lymph node involvement. |
BC LymphNodeSize Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Size of the lymph node or lymph node group which is being clinically assessed. |
BC MammaprintRecurrenceScore Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Breast cancer genomic signature assay for 10-year risk of distant recurrence score calculated by Mammaprint. In the United States, MammaPrint can only be used on cancers that are stage I or stage II, invasive, smaller than 5 centimeters, and estrogen-receptor-positive or -negative. Scores range from -1.0 to +1.0, with scores less than 0 indicating high risk, and scores greater than 0 indicating low risk. The is currently no LOINC code for Mammaprint test. |
BC ManufactureDate Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | When the item (medication, device, etc.) was produced. |
BC Manufacturer Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The organization producing the product or test. |
BC ManufacturerName Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The name of the company who produce the device. |
BC Media Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A file that contains audio, video, image, or similar content. |
BC Medication Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A type of prescription drug or over-the-counter drug that is used to prevent, treat, or relieve symptoms of a disease or abnormal condition, but excluding vaccines. |
BC MedicationIngredient Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Specifies an material component in a medication. |
BC Member Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A person or entity in a group. |
BC MiddleName Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The person's middle name. |
BC MitoticCountScore Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The degree of mitotic activity in breast carcinoma is one component of the Nottingham histologic grade, which is a prognostic indicator for patients with breast carcinoma. Mitotic activity is assessed as the number of mitoses per 10 high power fields (HPF), with increasing mitotic activity being an indicator of more aggressive cancer. The specific scores assigned to the number of mitoses depends on the size of the HPF. For example, for a HPF size of 0.274 mm^2, less than 10 mitoses per 10 HPF gets a score of 1, 10-19 gets a score of 2, and greater than or equal to 20 gets a score of 3. When larger or smaller HPFs are used, the cutoffs for the number of mitoses corresponding to a specific score are adjusted according to published guidelines. |
BC MorphologyBehavior Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A description of the morphology and behavioral characteristics of the cancer. |
BC Name Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Abstract supertype for the name of an entity. |
BC NameAsText Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The name as plain unstructured or semi-structured text. |
BC NationalProviderIdentifier Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry. |
BC NonIndependent Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Parent for classes in CIMI that do not have enough context to stand alone. These reusable building blocks/data elements can be used to create classes by composition. |
BC NonLaboratoryObservation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An observation not based on a specimen. |
BC NuclearPleomorphismScore Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The degree of nuclear pleomorphism (variability of nuclei) in breast carcinoma is one component of the Nottingham histologic grade, which is a prognostic indicator for patients with breast carcinoma. Increasing degrees of pleomorphism are associated with increasingly aggressive cancers. |
BC NumberOfLymphNodesWithIsolatedTumorCells Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Number of lymph nodes with isolated metatstatic tumor cells examined for the presence of cancer cells |
BC NumberOfLymphNodesWithMacrometastases Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Number of lymph nodes with macrometastases examined |
BC NumberOfLymphNodesWithMicrometastases Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Number of lymph nodes with micrometastases examined |
BC NumberOfRegionalLymphNodes Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Number of regional lymph nodes examined for the presence of cancer cells |
BC NumberOfSentinelLymphNodes Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Number of sentinel lymph nodes examined for the presence of cancer cells |
BC Numerator Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The dividend of a fraction. |
BC Observation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Represents the result of evaluations (measurements, tests, or questions) that have been performed. Observation has a value representing the result (answer), or an ExceptionValue indicating why the value is not present. The subject of a finding can be the entire patient, or an entity such as a location body structure, intervention, or condition. Things observed about the subject can include social and behavioral factors, subjective and objective observations, and assessments. |
BC ObservationContext Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Context for recording an evaluation result, used to indicate an evaluation has been made. |
BC ObservationTopic Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The base class, independent of context for evaluations (measurements, tests, or questions). The subject of a finding can be the entire patient, or an entity such as a location body structure, intervention, or condition. Things observed about the subject can include social and behavioral factors, subjective and objective observations, and assessments. |
BC Observer Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The person or organization who observed or informed the reporter about the characteristic, potentially the clinician, the patient, or a related person. |
BC OncotypeDxDCISRecurrenceScore Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The Oncotype DX test for DCIS (Ductal Carcinoma in Situ) breast cancer. Risk scores range from 0 to 100 with the following interpretations: 0-38: Low-Risk, 39-54: Intermediate-Risk, 55+: High-Risk. No LOINC code currently exists for this test. We are seeking feedback on the value of separating OncotypeDx scores for DCIS and invasive breast carcinomas. Does it make more sense to report the OncotypeDx as a single score, regardless of the type of cancer? |
BC OncotypeDxInvasiveRecurrenceScore Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The Oncotype DX test for invasive breast cancer examines the activity of 21 genes in a patient’s breast tumor tissue to provide personalized information for tailoring treatment based on the biology of their individual disease. The value from 0 to 100 indicates the estimated risk of recurrence, with the highest risk indicated by a score greater than 31. No LOINC code currently exists for this test. We are seeking feedback on the value of separating OncotypeDx scores for DCIS and invasive breast carcinomas. Does it make more sense to report the OncotypeDx as a single score, regardless of the type of cancer? |
BC Onset Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The beginning or first appearance of a mental or physical disorder. |
BC Organization Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A social or legal structure formed by human beings. |
BC OrganizationAlias Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A list of alternate names that the organization is known as, or was known as in the past. |
BC OrganizationIdentifier Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An identifier of the organization. An NPI preferred, tax id is allowed, and a local id is allowed in addition to ‘authoritative’ identifier |
BC OrganizationName Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The name of the organization. |
BC OverTheCounter Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | True if the medication is available to consumers without a prescription. |
BC Package Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The kind of container the medication comes in. |
BC PanelMembers Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | PanelMembers represent the elements of a group of a related but independent evaluations. Examples are the measurements that compose a complete blood count (CBC), or the elements of a pathology report. Each member is an independent evaluation, but the grouping reflects a composite lab order, shared specimen, or a single report author. Typically the Category and Reason are not given for individual findings that are part of the panel, but rather given at the level of the panel itself. |
BC ParticipationPeriod Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The point in time or span of time the participant is involved. |
BC PartOf Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The larger entity that this is a portion of. For example, an organization might be part of a larger organization, or an encounter with a hospitalist might be part of a larger hospitalization encounter. |
BC Patient Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A person in the role of a patient, including extended demographic information about the subject of this health record. |
BC Person Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A person relevant to the health or social situation of the subject (including the person of record him or herself). |
BC PersonName Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A name used by a human being, written as it would be typically expressed. May include a breakdown of the various elements of the name (family name, given name, etc.). |
BC PersonOfRecord Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The person this entry belongs to. |
BC PostalCode Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A sequence of letters and digits used as part of a postal address, often designating a geographic region |
BC Practitioner Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A person who practices a healing art. |
BC Precondition Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A description of the conditions or context of an observation, for example, under sedation, fasting or post-exercise. Body position and body site are also qualifiers, but handled separately. A qualifier cannot modify the measurement type; for example, a fasting blood sugar is still a blood sugar. |
BC Prefix Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Contains a set of honorific terms that typically appear before a person's name, for example Mr., Mrs., Dr., etc. |
BC PresenceContext Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | PresenceContext indicates that the finding in question exists or is present to some level of certainty. For example, if the finding involves a myocardial infarction, the presence context implies that cardiac arrest has (or may have) taken place. Note that the name Presence is used rather than Present to prevent confusion with the temporal meaning of present. |
BC PresentOnAdmission Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | If the problem or condition existed before the current episode of care. |
BC PriorityRank Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An indication of the importance of an action. |
BC ProgesteroneReceptorAverageStainingIntensity Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The degree or magnitude of staining across positively stained tumor cells on the entire tissue section relative to the intensity of positive controls run with the same batch. |
BC ProgesteroneReceptorNuclearPositivity Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The percentage of cells that test (stain) positive for the presence of progesterone receptors. We are seeking feedback on whether nuclear positivity should be an exact percentage or a range of percentages. As currently defined, an exact nuclear positivity could be represented by a zero-width range, where the lower and upper bounds would be the same number. We are seeking feedback on whether nuclear positivity should be an exact percentage or a range of percentages. As currently defined, an exact nuclear positivity could be represented by a zero-width range, where the lower and upper bounds would be the same number. |
BC ProgesteroneReceptorStatus Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Progesterone receptor status is a factor in determining prognosis and treatment options. The value is the percentage of cells that test (stain) positive for the presence of a receptor. The interpretation of positive or negative (found in the interpretation property) is based on the staining percentage, and may take into account the staining intensity. Based on discussion with Cancer Interoperability Group subject matter experts, there was insufficient rationale to include the following components in the data model: StainingControl, PrimaryAntibody, Allred Score (both total and component scores). We are seeking feedback on whether or not those components should be included in this model. |
BC ProsignaRecurrenceScore Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Breast cancer genomic signature assay for 10-year risk of distant recurrence score calculated by Prosigna. The Prosigna Score is reported on a 0-100 scale (referred to as ROR Score or Risk of Recurrence Score in the literature), which is correlated with the probability of distant recurrence at ten years for post-menopausal women with hormone receptor positive, early stage breast cancer. |
BC Purpose Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Why the item is used. |
BC Qualification Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A right to practice medicine obtained by training and certification. |
BC Quantity Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A quantity with units, whose value may be bounded from above or below, as defined in FHIR |
BC Range Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | An interval defined by a quantitative upper and/or lower bound. One of the two bounds must be specified, and the lower bound must be less than the upper bound. When Quantities are specified, the units of measure must be the same. |
BC Ratio Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A unit of measurement for the quotient of the amount of one entity to another. |
BC ReceivedTime Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Time the item was delivered to, or accepted by, the receiving facility or unit. |
BC RecordedContext Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Context for recording a finding, used to indicate an evaluation has been made. |
BC ReferenceRange Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The usual or acceptable range for a test result. |
BC RelatedPerson Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A person in a role defined in relationship to a patient |
BC RelationshipToPersonOfRecord Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The relationship of the person to the subject of record. |
BC RelevantTime Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The time or time period that the finding addresses. The clinically relevant time is not necessarily when the information is gathered or when a test is carried out, but for example, when a specimen was collected, or the time period referred to by the question. Use a TimePeriod for a measurement or specimen collection continued over a significant period of time (e.g. 24 hour Urine Sodium). |
BC ResourceLocation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | URI where data can be found. |
BC ResourceSize Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Number of bytes of content in the resource (if url provided) |
BC ResultValue Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The finding itself, such as the blood pressure value recorded. |
BC Role Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Capacity in which an actor is involved in an activity. For instance, 'attending physician'. Note that attributes of the actor (an entity) that remain constant regardless of the role the actor plays should be part of the entity and not the role. For instance, a person may be a practitioner and a patient. In both cases their date of birth will be the same and thus such information should not be part of the role. |
BC SequenceNumber Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The sequence number for this specimen in a collection of specimens. |
BC Severity Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Degree of harshness or extent of a symptom, disorder, or condition. |
BC SimpleCodedLaboratoryObservation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A coded finding from a laboratory test without further panel members or components. |
BC SimpleLaboratoryObservation Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A coded finding from a laboratory test without further panel members or components. |
BC SimpleQuantity Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A quantity where the comparator is not used, as defined in FHIR |
BC SizeOfGrossTumorBed Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The largest dimension of the gross tumor bed and surrounding fibrotic area. |
BC SizeOfLongestDiameter Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Measurements for the primary tumor size which includes the longest diameter of the primary tumor and the longest perpendicular diameter of the primary tumor. |
BC SizeOfShortAxis Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Measurements for the primary tumor size which includes the longest diameter of the primary tumor and the longest perpendicular diameter of the primary tumor. |
BC SourceSpecimen Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Identifier for the source specimen from which this specimen was derived. |
BC SpecialHandling Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Information about the proper handling of the specimen. |
BC Specimen Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A specimen is a substance, physical object, or collection of objects, that the laboratory considers a single discrete, uniquely identified unit that is the subject of one or more steps in the laboratory workflow. A specimen may include multiple physical pieces as long as they are considered a single unit within the laboratory workflow. A specimen results from one to many specimen collection procedures, and may be contained in multiple specimen containers. Specimen may have one or more processing activities. |
BC SpecimenContainer Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Direct container of specimen (tube/slide, etc.) |
BC SpecimenQuantity Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Quantity of specimen within container. |
BC SpecimenStatus Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | State of the specimen, such as obtained, processed, used. |
BC SpecimenTreatment Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Treatment performed on the specimen. |
BC SpokenLanguageProficiency Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Accuracy and fluency in spoken communication in a language. |
BC Stage Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The relative advancement in the course of a disease. The value is the summary stage or stage group. StageDetail optionally contains the full staging information. |
BC StageDetail Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The full staging information |
BC StageSuffix Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A suffix used in conjuction with certain cancer stages, based on criteria defined by the staging system being used. |
BC StageTimingPrefix Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Indicates when the staging was done, in terms of treatment landmarks. |
BC State Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). (Source: HL7 FHIR). |
BC StatementContext Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Compositional and reusable grouping of clinical statement attributes that provides the context for the topic of a clinical statement. The StatementContext class aligns with the SNOMED CT Situations with Explicit Context (SWEC) Concept Model. The StatementContext provides the expressivity required to specify that an act was performed or not performed or that a finding was asserted to be present or absent for the given subject of information. It also often holds provenance information relevant to the context of the clinical statement. It is important to note that by default the context applies to the conjunction of the attribute specified in the statement. For instance, if a clinical statement has a topic describing a rash on left arm and a context of 'absent', then the statement states that the subject of interest did not have a rash on the left arm but might have had one on the right arm. |
BC StatementTopic Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Compositional and reusable grouping of clinical statement attributes that make up the clinical focus of a statement. StatementTopic class attributes are aligned with SNOMED CT Concept Model attributes when such an overlap exists. Note that this class does not include contextual attributes such as the nature of the action (ordered, proposed, planned, etc...), the nature of the patient state being described (e.g., present, suspected present, absent), and the attribution of this information (the who, when, where, how, why of the information recorded). |
BC Status Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The current standing or state. |
BC Substance Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical. |
BC Suffix Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. |
BC TelecomNumberOrAddress Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A user name or other identifier on a telecommunication network, such as a telephone number (including country code and extension, if necessary), email address, or SkypeID. |
BC TimePeriod Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A period of time defined by a start and end time, date, or year. If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May. |
BC TimePeriodEnd Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The time at which something is to end or did end. Boundary is considered inclusive. |
BC TimePeriodStart Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The time at which something is to take effect, start, or did start. Boundary is considered inclusive. |
BC Title Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A distinguishing word or group of words naming an item. |
BC TopicCode Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The concept representing the finding or action that is the topic of the statement. For action topics, the TopicCode represents the action being described. For findings, the TopicCode represents the 'question' or property being investigated. For evaluation result findings, the TopicCode contains a concept for an observable entity, such as systolic blood pressure. For assertion findings, the TopicCode contains a code representing the condition, allergy, or other item being asserted. In all cases, the TopicCode describes the topic independent of the context of the action or the finding. |
BC TotalNumberOfLymphNodesExamined Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Total number of lymph nodes examined for the presence of cancer cells |
BC TubuleFormationScore Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The degree of glandular differentiation or tubule formation in breast carcinoma is one component of the Nottingham histologic grade, which is a prognostic indicator for patients with breast carcinoma. Less aggressive cancers have more tubule formation. |
BC TumorDimensions Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Dimension size of the tumor sample evaluated for staging. Dimensions include a size measurements for the longest diameter and the short axis (per RECIST guidelines) as well as margin measurements. |
BC TumorIdentifier Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A human-readable identifier for the lesion; e.g., a letter or integer. |
BC TumorMarginDescription Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Description of the edge or border of tumor in situ by radiologist or of removed tumor by pathologist. |
BC TumorMargins Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The edge or border of the tissue removed in cancer surgery. The margin is described as negative or clean when the pathologist finds no cancer cells at the edge of the tissue, suggesting that all of the cancer has been removed. The margin is described as positive or involved when the pathologist finds cancer cells at the edge of the tissue, suggesting that all of the cancer has not been removed. |
BC Type Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The most specific code (lowest level term) describing the kind or sort of thing being represented. |
BC Units Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Code for the unit of measure of the quantity. |
BC UpperBound Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The upper limit on a quantitative value. |
BC Url Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A unique URL on which the device may be contacted directly. |
BC VendorModelNumber Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The model number of the device, assigned by the manufacturer or vendor. |
BC VerificationStatus Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Whether an assessment has been confirmed by testing or observation. CIMI Alignment: This attribute corresponds to FindingContext.status, but has been defined to align with FHIR. In AllergyIntolerance, the type is code. |
BC Version Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | A number or code associated with the product that identifies a particular release iteration. |
BC WhenClinicallyRecognized Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | The time at which a condition or condition was first identified in a healthcare context. |
BC WrittenLanguageProficiency Logical Model | hl7.fhir.us.breastcancer#0.2.0 | R3 | Accuracy and fluency of reading and writing in a language. |
Birth Sex Observation (V2) | hl7.cda.us.ccda#current | R5 | This observation represents the sex of the patient at birth. It is the sex that is entered on the person's birth certificate at time of birth. This observation is not appropriate for recording patient gender (administrativeGender). This observation is not appropriate for recording Gender Identity (GI). It is recommended systems include the Birth Sex observation in the Social History section. |
Brand Name Observation | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to exchange the **Brand Name**. The UDI-DI of the medical device may be used to retrieve the **Brand Name** in accessGUDID, which should be considered the source of truth. |
Care Plan | hl7.cda.us.ccda#current | R5 | CARE PLAN FRAMEWORK A Care Plan (including Home Health Plan of Care (HHPoC)) is a consensus-driven dynamic plan that represents a patient's and Care Team Member's prioritized concerns, goals, and planned interventions. It serves as a blueprint shared by all Care Team Members (including the patient, their caregivers and providers), to guide the patient'ss care. A Care Plan integrates multiple interventions proposed by multiple providers and disciplines for multiple conditions. A Care Plan represents one or more Plan(s) of Care and serves to reconcile and resolve conflicts between the various Plans of Care developed for a specific patient by different providers. While both a plan of care and a care plan include the patients life goals and require Care Team Members (including patients) to prioritize goals and interventions, the reconciliation process becomes more complex as the number of plans of care increases. The Care Plan also serves to enable longitudinal coordination of care. The CDA Care Plan represents an instance of this dynamic Care Plan at a point in time. The CDA document itself is NOT dynamic. Key differentiators between a Care Plan CDA and CCD (another snapshot in time document): There are 2 required sections: * Health Concerns * Interventions There are 2 optional sections: * Goals * Outcomes Provides the ability to identify patient and provider priorities with each act Provides a header participant to indicate occurrences of Care Plan review A care plan document can include entry references from the information in these sections to the information (entries) in other sections. Please see Volume 1 of this guide to view a Care Plan Relationship diagram and story board. |
Care Team Member Act (V2) | hl7.cda.us.ccda#current | R5 | This template is used to represent a member of the care team. Care team members can include healthcare and community services providers, caregivers, relatives, the patient themselves, etc. A care team member can be another care team or an organization. Care team member attributes include the following: Care team member status on the care team Care team member time (e.g. duration, point-in-time, etc.) on the care team Schedule of the care team member describing when the care team member usually participates on the care team Care team member function on the care team such as the care team member specialty, relationship to the patient, and also role on the care team Care team member name, address, telecom, organization, etc. Care team member information (narrative description about the care team member) The performer/assignedEntity/id may be set equal to (a pointer to) an id on a performer elsewhere in the document (header or entries) or a new performer can be described here. If the id is pointing to a performer already described elsewhere in the document, assignedEntity/id is sufficient to identify this performer and none of the remaining details of assignedEntity are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. This id must be a pointer to another Performer. |
Care Team Member Schedule Observation (V2) | hl7.cda.us.ccda#current | R5 | This template represents the schedule of when the care team member participates on the care team. Examples include: An oncologist who participated on the care team for one week. A primary care provider who participated on a care team during one summer (e.g. in the case of patients who are snow-birds). A crisis team who participated on the care team for the patient during an inpatient stay (e.g. in the case of children with special needs). |
Care Team Organizer (V2) | hl7.cda.us.ccda#current | R5 | This organizer template contains information about a single care team. The author of the organizer is the person who documented the care team information. The participants of the organizer are the care team lead(s) and the care team organization. The components of the organizer contain the following information: * The encounter that caused the care team to be formed * Narrative information about the care team * The care team members * Reasons for the care team * The care team type(s) - a care team can have multiple care team types |
Care Team Type Observation | hl7.cda.us.ccda#current | R5 | This template is used to express the care team type. A care team can have multiple care team types. Examples include but are not limited to: * Condition focused, longitudinal care team * Event focused, Home & Community Based Services care team * Condition focused, clinical research care team * Public health focused, Longitudinal care-coordination care team |
Care Teams Section (V2) | hl7.cda.us.ccda#current | R5 | The Care Team Section is used to share historical and current Care Team information. The Care Team Section may be included in any type of C-CDA structured document that is an open template. An individual can have more than one Care Team. A Care Team can exist over time such as a longitudinal care team which includes historical members that may be active or inactive on the care team as needed. Or a Care Team, such as a rehabilitation team, may exist to address a person's needs associated with a particular care event, or a team can be based on addressing a specific condition. The Care Team Organizer entry template used in the C-CDA Care Teams Section is meant to support the foundation of effective communication, interaction channels and maintenance of current clinical context awareness for the patient, caregivers and care providers to promote care coordination. |
Caregiver Characteristics | hl7.cda.us.ccda#current | R5 | This clinical statement represents a caregiver's willingness to provide care and the abilities of that caregiver to provide assistance to a patient in relation to a specific need. |
Catalog Number Observation | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to exchange the **Catalog Number**. The UDI-DI of the medical device may be used to retrieve the Catalog Number in accessGUDID, which should be considered the source of truth. |
CDS Hooks Services Configuration Extension | hl7.fhir.us.davinci-crd#current | R4 | An extension for the CDS Hooks 'services' object that indicates configuration options supported by the CDS server |
Characteristics of Home Environment | hl7.cda.us.ccda#current | R5 | This template represents the patient's home environment including, but not limited to, type of residence (trailer, single family home, assisted living), living arrangement (e.g., alone, with parents), and housing status (e.g., evicted, homeless, home owner). |
Chief Complaint and Reason for Visit Section | hl7.cda.us.ccda#current | R5 | This section records the patient's chief complaint (the patient's own description) and/or the reason for the patient's visit (the provider's description of the reason for visit). Local policy determines whether the information is divided into two sections or recorded in one section serving both purposes. |
Chief Complaint Section | hl7.cda.us.ccda#current | R5 | This section records the patient's chief complaint (the patient's own description). |
Cognitive Status Problem Observation (DEPRECATED) | hl7.cda.us.ccda#current | R5 | A cognitive status problem observation is a clinical statement that describes a patient's cognitive condition, findings, or symptoms. Examples of cognitive problem observations are inability to recall, amnesia, dementia, and aggressive behavior. A cognitive problem observation is a finding or medical condition. This is different from a cognitive result observation, which is a response to a question that provides insight into the patient's cognitive status, judgement, comprehension ability, or response speed. THIS TEMPLATE HAS BEEN DEPRECATED AND MAY BE DELETED FROM A FUTURE RELEASE OF THIS IMPLEMENTATION GUIDE. USE OF THIS TEMPLATE IS NOT RECOMMENDED. *Reason for deprecation*: Cognitive Status Problem Observation has been merged, without loss of expressivity, into Mental Status Observation (2.16.840.1.113883.10.20.22.4.74). |
Comment Activity | hl7.cda.us.ccda#current | R5 | Comments are free text data that cannot otherwise be recorded using data elements already defined by this specification. They are not to be used to record information that can be recorded elsewhere. For example, a free text description of the severity of an allergic reaction would not be recorded in a comment. |
Company Name Observation | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to exchange the **Company Name**. The UDI-DI of the medical device may be used to retrieve the **Company Name** in accessGUDID, which should be considered the source of truth. |
Complications Section | hl7.cda.us.ccda#current | R5 | This section contains problems that occurred during or around the time of a procedure. The complications may be known risks or unanticipated problems. |
Consultation Note | hl7.cda.us.ccda#current | R5 | The Consultation Note is generated by a request from a clinician for an opinion or advice from another clinician. Consultations may involve face-to-face time with the patient or may fall under the auspices of telemedicine visits. Consultations may occur while the patient is inpatient or ambulatory. The Consultation Note should also be used to summarize an Emergency Room or Urgent Care encounter. A Consultation Note includes the reason for the referral, history of present illness, physical examination, and decision-making components (Assessment and Plan). |
Continuity of Care Document (CCD) | hl7.cda.us.ccda#current | R5 | This document type was originally based on the Continuity of Care Document (CCD) Release 1.1 which itself was derived from HITSP C32 and CCD Release 1.0. The Continuity of Care Document (CCD) represents a core data set of the most relevant administrative, demographic, and clinical information facts about a patient's healthcare, covering one or more healthcare encounters. It provides a means for one healthcare practitioner, system, or setting to aggregate all of the pertinent data about a patient and forward it to another to support the continuity of care. The primary use case for the CCD is to provide a snapshot in time containing the germane clinical, demographic, and administrative data for a specific patient. The key characteristic of a CCD is that the ServiceEvent is constrained to "PCPR". This means it does not function to report new ServiceEvents associated with performing care. It reports on care that has already been provided. The CCD provides a historical tally of the care over a range of time and is not a record of new services delivered. More specific use cases, such as a Discharge Summary, Transfer Summary, Referral Note, Consultation Note, or Progress Note, are available as alternative documents in this guide. |
Course of Care Section | hl7.cda.us.ccda#current | R5 | The Course of Care section describes what happened during the course of an encounter. |
Coverage Activity (V4) | hl7.cda.us.ccda#current | R5 | A Coverage Activity groups the policy and authorization acts within a Payers Section to order the payment sources. A Coverage Activity contains one or more Policy Activities, each of which contains zero or more Authorization Activities. The sequenceNumber/@value shows the policy order of preference. The Member Identifier is described in the contained Policy Activity Template 2.16.840.1.113883.10.20.22.4.61. |
CRD Metric Data | hl7.fhir.us.davinci-crd#current | R4 | A logical model describing the information that should be captured by CRD implementers about every CRD invocation to support measures evaluating CRD implementation |
Criticality Observation | hl7.cda.us.ccda#current | R5 | This observation represents the gravity of the potential risk for future life-threatening adverse reactions when exposed to a substance known to cause an adverse reaction in that individual. When the worst case result is assessed to have a life-threatening or organ system threatening potential, it is considered to be of high criticality. |
Cultural and Religious Observation | hl7.cda.us.ccda#current | R5 | This template represents a patient's spiritual, religious, and cultural belief practices, such as a kosher diet or fasting ritual. religiousAffiliationCode in the document header captures only the patient's religious affiliation. |
Date of Diagnosis Act | hl7.cda.us.ccda#current | R5 | This template represents the earliest date of diagnosis, which is the date of first determination by a qualified professional of the presence of a problem or condition affecting a patient. An encounter diagnosis date may be different than this Date of Diagnosis. The date of diagnosis is usually not the same date as the date of condition onset. A patient may have a condition for some time before it is formally diagnosed. |
Deceased Observation | hl7.cda.us.ccda#current | R5 | This template represents the observation that a patient has died. It also represents the cause of death, indicated by an entryRelationship type of CAUS. This template allows for more specific representation of data than is available with the use of dischargeDispositionCode. |
Device Identifier Observation (V2) | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to exchange the **Device Identifier** (also known as the "Primary DI Number") for a medical device marketed in the US. The device identifier is parsed from the UDI value. The Device Identifier number can be used as a key to look-up device identification information in the publicly available version of the US FDA Global UDI Database (GUDID) - the AccessGUDID: https://accessgudid.nlm.nih.gov/resources/home |
Disability Status Observation | hl7.cda.us.ccda#current | R5 | This template represents an assessment of patients perception of their physical, cognitive, intellectual, or psychiatric disabilities. It may contain an Assessment Scale Observation that holds the six-item set of questions used on the American Community Survey (ACS) to gauge disability, defined here: [HHS Implementation Guidance on Data Collection Standards for Race, Ethnicity, Sex, Primary Language, and Disability Status](https://aspe.hhs.gov/basic-report/hhs-implementation-guidance-data-collection-standards-race-ethnicity-sex-primary-language-and-disability-status) This template SHOULD be included zero or more times [0..*] in the Functional Status Section V2 or the Functional Status Organizer (V2). |
Discharge Diagnosis Section | hl7.cda.us.ccda#current | R5 | This template represents problems or diagnoses present at the time of discharge which occurred during the hospitalization. This section includes an optional entry to record patient diagnoses specific to this visit. Problems that need ongoing tracking should also be included in the Problem Section. |
Discharge Diet Section (DEPRECATED) | hl7.cda.us.ccda#current | R5 | This section records a narrative description of the expectations for diet and nutrition, including nutrition prescription, proposals, goals, and order requests for monitoring, tracking, or improving the nutritional status of the patient, used in a discharge from a facility such as an emergency department, hospital, or nursing home. THIS TEMPLATE HAS BEEN DEPRECATED IN C-CDA R2 AND MAY BE DELETED FROM A FUTURE RELEASE OF THIS IMPLEMENTATION GUIDE. USE OF THIS TEMPLATE IS NOT RECOMMENDED. *Reason for deprecation*: This template has been replaced by the Nutrition Section (2.16.840.1.113883.10.20.22.2.57). |
Discharge Medication | hl7.cda.us.ccda#current | R5 | This template represents medications that the patient is intended to take (or stop) after discharge. |
Discharge Medications Section | hl7.cda.us.ccda#current | R5 | This section contains the medications the patient is intended to take or stop after discharge. Current, active medications must be listed. The section may also include a patient's prescription history and indicate the source of the medication list. |
Discharge Summary | hl7.cda.us.ccda#current | R5 | The Discharge Summary is a document which synopsizes a patient's admission to a hospital, LTPAC provider, or other setting. It provides information for the continuation of care following discharge. The Joint Commission requires the following information to be included in the Discharge Summary (http://www.jointcommission.org/): * The reason for hospitalization (the admission) * The procedures performed, as applicable * The care, treatment, and services provided * The patients condition and disposition at discharge * Information provided to the patient and family * Provisions for follow-up care The best practice for a Discharge Summary is to include the discharge disposition in the display of the header. |
Distinct Identification Code Observation | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to exchange the **Distinct Identification Code** for an HCT/P product regulated as a device as cited in 21 CFR 1271.290(c). The distinct identification code is parsed from the UDI value, if present. The distinct identification code may be equivalent to the serial number, lot or batch number, or the donation identification number. The appropriate value should be provided as the distinct identification code. |
Drug Monitoring Act | hl7.cda.us.ccda#current | R5 | This template represents the act of monitoring the patient's medication and includes a participation to record the person responsible for monitoring the medication. The prescriber of the medication is not necessarily the same person or persons monitoring the drug. The effectiveTime indicates the time when the activity is intended to take place. For example, a cardiologist may prescribe a patient Warfarin. The patient's primary care provider may monitor the patient's INR and adjust the dosing of the Warfarin based on these laboratory results. Here the person designated to monitor the drug is the primary care provider. |
Drug Vehicle | hl7.cda.us.ccda#current | R5 | This template represents the vehicle (e.g., saline, dextrose) for administering a medication. |
DTR Metric Data | hl7.fhir.us.davinci-dtr#current | R4 | A logical model describing the information that should be captured by DTR implementers about every DTR invocation to support measures evaluating DTR implementation. |
Encounter Activity | hl7.cda.us.ccda#current | R5 | This clinical statement describes an interaction between a patient and clinician. Interactions may include in-person encounters, telephone conversations, and email exchanges. |
Encounter Diagnosis | hl7.cda.us.ccda#current | R5 | This template wraps relevant problems or diagnoses at the close of a visit or that need to be followed after the visit. If the encounter is associated with a Hospital Discharge, the Hospital Discharge Diagnosis must be used. This entry requires at least one Problem Observation entry. |
Encounters Section | hl7.cda.us.ccda#current | R5 | This section lists and describes any healthcare encounters pertinent to the patient's current health status or historical health history. An encounter is an interaction, regardless of the setting, between a patient and a practitioner who is vested with primary responsibility for diagnosing, evaluating, or treating the patient's condition. It may include visits, appointments, as well as non-face-to-face interactions. It is also a contact between a patient and a practitioner who has primary responsibility (exercising independent judgment) for assessing and treating the patient at a given contact. This section may contain all encounters for the time period being summarized, but should include notable encounters. |
Entry Reference | hl7.cda.us.ccda#current | R5 | This template represents the act of referencing another entry in the same CDA document instance. Its purpose is to remove the need to repeat the complete XML representation of the referred entry when relating one entry to another. This template can be used to reference many types of Act class derivations, such as encounters, observations, procedures etc., as it is often necessary when authoring CDA documents to repeatedly reference other Acts of these types. For example, in a Care Plan it is necessary to repeatedly relate Health Concerns, Goals, Interventions and Outcomes. The id is required and must be the same id as the entry/id it is referencing. The id cannot be a null value. Act/Code is set to nullFlavor="NP" (Not Present). This means the value is not present in the message (in act/Code). |
Establishment Registration Logical Model | hl7.fhir.us.spl#current | R4B | An operation to register Establishment organizations. |
Estimated Date of Delivery | hl7.cda.us.ccda#current | R5 | This clinical statement represents the anticipated date when a woman will give birth. |
Expiration Date Observation | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to exchange the **Expiration Date** of the device. The expiration date is parsed from the UDI value, if present. |
External Document Reference | hl7.cda.us.ccda#current | R5 | Where it is necessary to reference an external clinical document, the External Document Reference template can be used to reference this external document. However, if the containing document is appending to or replacing another document in the same set, that relationship is set in the header, using ClinicalDocument/relatedDocument. |
Family History Death Observation | hl7.cda.us.ccda#current | R5 | This clinical statement records whether the family member is deceased. |
Family History Observation | hl7.cda.us.ccda#current | R5 | Family History Observations related to a particular family member are contained within a Family History Organizer. The effectiveTime in the Family History Observation is the biologically or clinically relevant time of the observation. The biologically or clinically relevant time is the time at which the observation holds (is effective) for the family member (the subject of the observation). |
Family History Organizer | hl7.cda.us.ccda#current | R5 | The Family History Organizer associates a set of observations with a family member. For example, the Family History Organizer can group a set of observations about the patient's father. |
Family History Section | hl7.cda.us.ccda#current | R5 | This section contains data defining the patient's genetic relatives in terms of possible or relevant health risk factors that have a potential impact on the patient's healthcare risk profile. |
Functional Status Observation | hl7.cda.us.ccda#current | R5 | This template represents the patient's physical function (e.g., mobility status, instrumental activities of daily living, self-care status) and problems that limit function (dyspnea, dysphagia). The template may include assessment scale observations, identify supporting caregivers, and provide information about non-medicinal supplies. This template is used to represent physical or developmental function of all patient populations. |
Functional Status Organizer | hl7.cda.us.ccda#current | R5 | This template groups related functional status observations into categories (e.g., mobility, self-care). |
Functional Status Problem Observation (DEPRECATED) | hl7.cda.us.ccda#current | R5 | A functional status problem observation is a clinical statement that represents a patient's functional perfomance and ability. THIS TEMPLATE HAS BEEN DEPRECATED IN C-CDA R2 AND MAY BE DELETED FROM A FUTURE RELEASE OF THIS IMPLEMENTATION GUIDE. USE OF THIS TEMPLATE IS NOT RECOMMENDED. *Reason for deprecation*: Functional Status Problem Observation has been merged, without loss of expressivity, into Functional Status Observation (2.16.840.1.113883.10.20.22.4.67:2014-06-09). |
Functional Status Section | hl7.cda.us.ccda#current | R5 | The Functional Status Section contains observations and assessments of a patient's physical abilities. A patient's functional status may include information regarding the patient's ability to perform Activities of Daily Living (ADLs) in areas such as Mobility (e.g., ambulation), Self-Care (e.g., bathing, dressing, feeding, grooming) or Instrumental Activities of Daily Living (IADLs) (e.g., shopping, using a telephone, balancing a check book). Problems that impact function (e.g., dyspnea, dysphagia) can be contained in the section. |
GDUFA Facility Identification Logical Model | hl7.fhir.us.spl#current | R4B | An operation to provide details about a GDUFA Facility. |
Gender Identity Observation (V4) | hl7.cda.us.ccda#current | R5 | This observation represents the gender identity of the patient, defined as: > "Ones basic sense of being male, female, or other gender (for example, transgender or gender queer). Gender identity can be congruent or incongruent with ones sex assigned at birth based on the appearance of external genitalia. (Advancing Effective Communication, Cultural Competence, and Patient- and Family-Centered Care for the Lesbian, Gay, Bisexual, and Transgender (LGBT) CommunityA Field Guide, The Joint Commission (2011).) This template follows the guidelines from the HL7 Gender Harmony project. This template is based on C-CDA Social History Observation template. This observation is not appropriate for recording patient gender (administrativeGender) or birth sex. |
General Status Section | hl7.cda.us.ccda#current | R5 | The General Status section describes general observations and readily observable attributes of the patient, including affect and demeanor, apparent age compared to actual age, gender, ethnicity, nutritional status based on appearance, body build and habitus (e.g., muscular, cachectic, obese), developmental or other deformities, gait and mobility, personal hygiene, evidence of distress, and voice quality and speech. |
Goal Observation (V2) | hl7.cda.us.ccda#current | R5 | This template represents a patient health goal. A Goal Observation template may have related components that are acts, encounters, observations, procedures, substance administrations, or supplies. A goal identifies a future desired condition or state. Goals are often related to physical or mental health conditions or diseases, but also may be related to a Social Determinant of Health (SDOH) risks or states. For example, to have adequate quality meals and snacks, gain transportation security - able to access health and social needs). SDOH data relate to conditions in which people live, learn, work, and play and their effects on health risks and outcomes. A Goal is established by the patient or provider. A goal may be a patient or provider goal. If the author is set to the recordTarget (patient), this is a patient goal. If the author is set to a provider, this is a provider goal. If both patient and provider are set as authors, this is a negotiated goal. A goal usually has a related health concern and/or risk. A goal may have components consisting of other goals (milestones). These milestones are related to the overall goal through entryRelationships. |
Goals Section | hl7.cda.us.ccda#current | R5 | This template represents patient Goals. A goal is a defined outcome or condition to be achieved in the process of patient care. Goals include patient-defined over-arching goals (e.g., alleviation of health concerns, desired/intended positive outcomes from interventions, longevity, function, symptom management, comfort) and health concern-specific or intervention-specific goals to achieve desired outcomes. |
Handoff Communication Participants | hl7.cda.us.ccda#current | R5 | This template represents the sender (author) and receivers (participants) of a handoff communication in a plan of treatment. It does not convey details about the communication. The "handoff" process involves senders, those transmitting the patient's information and releasing the care of that patient to the next clinician, and receivers, those who accept the patient information and care of that patient. |
Health Concern Act (V3) | hl7.cda.us.ccda#current | R5 | This template represents a health concern. It is a wrapper for a single health concern which may be derived from a variety of sources within an EHR (such as Problem List, Family History, Social History, Social Worker Note, etc.). A Health Concern Act is used to track non-optimal physical or psychological situations drawing the patient to the healthcare system. These may be from the perspective of the care team or from the perspective of the patient. When the underlying condition is of concern (i.e., as long as the condition, whether active or resolved, is of ongoing concern and interest), the statusCode is active. Only when the underlying condition is no longer of concern is the statusCode set to completed. The effectiveTime reflects the time that the underlying condition was felt to be a concern; it may or may not correspond to the effectiveTime of the condition (e.g., even five years later, a prior heart attack may remain a concern). Health concerns require intervention(s) to increase the likelihood of achieving the goals of care for the patient and they specify the condition oriented reasons for creating the plan. |
Health Concerns Section | hl7.cda.us.ccda#current | R5 | This section contains data describing an interest or worry about a health state or process that could possibly require attention, intervention, or management. A Health Concern is a health related matter that is of interest, importance or worry to someone, who may be the patient, patient's family or patient's health care provider. Health concerns are derived from a variety of sources within an EHR (such as Problem List, Family History, Social History, Social Worker Note, etc.). Health concerns can be medical, surgical, nursing, allied health or patient-reported concerns. Problem Concerns are a subset of Health Concerns that have risen to the level of importance that they typically would belong on a classic "Problem List", such as "Diabetes Mellitus" or "Family History of Melanoma" or "Tobacco abuse". These are of broad interest to multiple members of the care team. Examples of other Health Concerns that might not typically be considered a Problem Concern include "Risk of Hyperkalemia" for a patient taking an ACE-inhibitor medication, or "Transportation difficulties" for someone who doesn't drive and has trouble getting to appointments, or "Under-insured" for someone who doesn't have sufficient insurance to properly cover their medical needs such as medications. These are typically most important to just a limited number of care team members. |
Health Status Evaluations and Outcomes Section | hl7.cda.us.ccda#current | R5 | This template represents observations regarding the outcome of care from the interventions used to treat the patient. These observations represent status, at points in time, related to established care plan goals and/or interventions. |
Health Status Observation | hl7.cda.us.ccda#current | R5 | This template represents information about the overall health status of the patient. To represent the impact of a specific problem or concern related to the patient's expected health outcome use the Prognosis Observation template 2.16.840.1.113883.10.20.22.4.113. |
Highest Pressure Ulcer Stage | hl7.cda.us.ccda#current | R5 | This observation contains a description of the wound tissue of the most severe or highest staged pressure ulcer observed on a patient. |
History and Physical | hl7.cda.us.ccda#current | R5 | A History and Physical (H&P) note is a medical report that documents the current and past conditions of the patient. It contains essential information that helps determine an individual's health status. The first portion of the report is a current collection of organized information unique to an individual. This is typically supplied by the patient or the caregiver, concerning the current medical problem or the reason for the patient encounter. This information is followed by a description of any past or ongoing medical issues, including current medications and allergies. Information is also obtained about the patient's lifestyle, habits, and diseases among family members. The next portion of the report contains information obtained by physically examining the patient and gathering diagnostic information in the form of laboratory tests, imaging, or other diagnostic procedures. The report ends with the clinician's assessment of the patient's situation and the intended plan to address those issues. A History and Physical Examination is required upon hospital admission as well as before operative procedures. An initial evaluation in an ambulatory setting is often documented in the form of an H&P note. |
History of Present Illness Section | hl7.cda.us.ccda#current | R5 | The History of Present Illness section describes the history related to the reason for the encounter. It contains the historical details leading up to and pertaining to the patient's current complaint or reason for seeking medical care. |
Hospital Admission Diagnosis | hl7.cda.us.ccda#current | R5 | This template represents problems or diagnoses identified by the clinician at the time of the patient's admission. This Hospital Admission Diagnosis act may contain more than one Problem Observation to represent multiple diagnoses for a Hospital Admission. |
Hospital Consultations Section | hl7.cda.us.ccda#current | R5 | The Hospital Consultations Section records consultations that occurred during the admission. |
Hospital Course Section | hl7.cda.us.ccda#current | R5 | The Hospital Course Section describes the sequence of events from admission to discharge in a hospital facility. |
Hospital Discharge Diagnosis | hl7.cda.us.ccda#current | R5 | This template represents problems or diagnoses present at the time of discharge which occurred during the hospitalization or need to be monitored after hospitalization. It requires at least one Problem Observation entry. |
Hospital Discharge Instructions Section | hl7.cda.us.ccda#current | R5 | The Hospital Discharge Instructions Section records instructions at discharge. |
Hospital Discharge Physical Section | hl7.cda.us.ccda#current | R5 | The Hospital Discharge Physical Section records a narrative description of the patient's physical findings. |
Hospital Discharge Studies Summary Section | hl7.cda.us.ccda#current | R5 | This section records the results of observations generated by laboratories, imaging procedures, and other procedures. The scope includes hematology, chemistry, serology, virology, toxicology, microbiology, plain x-ray, ultrasound, CT, MRI, angiography, echocardiography, nuclear medicine, pathology, and procedure observations. This section often includes notable results such as abnormal values or relevant trends, and could record all results for the period of time being documented. Laboratory results are typically generated by laboratories providing analytic services in areas such as chemistry, hematology, serology, histology, cytology, anatomic pathology, microbiology, and/or virology. These observations are based on analysis of specimens obtained from the patient and submitted to the laboratory. Imaging results are typically generated by a clinician reviewing the output of an imaging procedure, such as when a cardiologist reports the left ventricular ejection fraction based on the review of an echocardiogram. Procedure results are typically generated by a clinician wanting to provide more granular information about component observations made during the performance of a procedure, such as when a gastroenterologist reports the size of a polyp observed during a colonoscopy. Note that there are discrepancies between CCD and the lab domain model, such as the effectiveTime in specimen collection. |
Immunization Activity | hl7.cda.us.ccda#current | R5 | An Immunization Activity describes immunization substance administrations that have actually occurred or are intended to occur. Immunization Activities in "INT" mood are reflections of immunizations a clinician intends a patient to receive. Immunization Activities in "EVN" mood reflect immunizations actually received. An Immunization Activity is very similar to a Medication Activity with some key differentiators. The drug code system is constrained to CVX codes. Administration timing is less complex. Patient refusal reasons should be captured. All vaccines administered should be fully documented in the patient's permanent medical record. Healthcare providers who administer vaccines covered by the National Childhood Vaccine Injury Act are required to ensure that the permanent medical record of the recipient indicates: 1. Date of administration 2. Vaccine manufacturer 3. Vaccine lot number 4. Name and title of the person who administered the vaccine and the address of the clinic or facility where the permanent record will reside 5. Vaccine information statement (VIS) a. Date printed on the VIS b. Date VIS given to patient or parent/guardian. This information should be included in an Immunization Activity when available. (Reference: [https://www.cdc.gov/vaccines/pubs/pinkbook/downloads/appendices/c/vis-instruct.pdf]) |
Immunization Medication Information | hl7.cda.us.ccda#current | R5 | The Immunization Medication Information represents product information about the immunization substance. The vaccine manufacturer and vaccine lot number are typically recorded in the medical record and should be included if known. |
Immunization Refusal Reason | hl7.cda.us.ccda#current | R5 | The Immunization Refusal Reason documents the rationale for the patient declining an immunization. |
Immunizations Section | hl7.cda.us.ccda#current | R5 | The Immunizations Section defines a patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. The section should include current immunization status, and may contain the entire immunization history that is relevant to the period of time being summarized. |
Implantable Device Status Observation | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to augment the parsed data from the a Unique Device Identifier (UDI). This template is used to exchange the status of the patient's implantable medical device. This status is only relevant to medical devices implanted in the patient's body. |
Implants Section (DEPRECATED) | hl7.cda.us.ccda#current | R5 | THIS TEMPLATE HAS BEEN DEPRECATED IN C-CDA R2 AND MAY BE DELETED FROM A FUTURE RELEASE OF THIS IMPLEMENTATION GUIDE. USE OF THIS TEMPLATE IS NOT RECOMMENDED. *Reason for Deprecation*: Replaced by the Procedure Implants Section (2.16.840.1.113883.10.20.22.2.40) |
Indication (V3) | hl7.cda.us.ccda#current | R5 | This template represents the rationale for an action such as an encounter, a medication administration, or a procedure. The id element can be used to reference a problem recorded elsewhere in the document, or can be used with a code and value to record the problem. Indications for treatment are not laboratory results; rather the problem associated with the laboratory result should be cited (e.g., hypokalemia instead of a laboratory result of Potassium 2.0 mEq/L). Use the Drug Monitoring Act [templateId 2.16.840.1.113883.10.20.22.4.123] to indicate if a particular drug needs special monitoring (e.g., anticoagulant therapy). Use Precondition for Substance Administration (V2) [templateId 2.16.840.1.113883.10.20.22.4.25.2] to represent that a medication is to be administered only when the associated criteria are met. Many templates in C-CDA R2.1 reference the Indications V2 Template. In the next C-CDA release we will update those templates to reference the Indications V3 template. The Reason 2.16.840.1.113883.10.20.24.3.88:2023-05-01 should used to represent the justification for an action, or for not performing an action, such as patient, system, or non-problem/diagnosis medical-related reasons Immunization Refusal Reason 2.16.840.1.113883.10.20.22.4.53 should be used to represent the rationale for the patient declining an immunization as the value set is crafted for the immunization use case. |
Instruction | hl7.cda.us.ccda#current | R5 | The Instruction template can be used in several ways, such as to record patient instructions within a Medication Activity or to record fill instructions within a supply order. The template's moodCode can only be INT. If an instruction was already given, the Procedure Activity Act template (instead of this template) should be used to represent the already occurred instruction. The act/code defines the type of instruction. Though not defined in this template, a Vaccine Information Statement (VIS) document could be referenced through act/reference/externalDocument, and patient awareness of the instructions can be represented with the generic participant and the participant/awarenessCode. |
Instructions Section | hl7.cda.us.ccda#current | R5 | The Instructions Section records instructions given to a patient. List patient decision aids here. |
Intervention Act | hl7.cda.us.ccda#current | R5 | This template represents an Intervention Act. It is a wrapper for intervention-type activities considered to be parts of the same intervention. For example, an activity such as "elevate head of bed" combined with "provide humidified O2 per nasal cannula" may be the interventions performed for a health concern of "respiratory insufficiency" to achieve a goal of "pulse oximetry greater than 92%". These intervention activities may be newly described or derived from a variety of sources within an EHR. Interventions are actions taken to increase the likelihood of achieving the patient's or providers' goals. An Intervention Act should contain a reference to a Goal Observation representing the reason for the intervention. Intervention Acts can be related to each other, or to Planned Intervention Acts. (E.g., a Planned Intervention Act with moodCode of INT could be related to a series of Intervention Acts with moodCode of EVN, each having an effectiveTime containing the time of the intervention.) All interventions referenced in an Intervention Act must have a moodCode of EVN, indicating that they have occurred. |
Interventions Section | hl7.cda.us.ccda#current | R5 | This template represents Interventions. Interventions are actions taken to maximize the prospects of the goals of care for the patient, including the removal of barriers to success. Interventions can be planned, ordered, historical, etc. Interventions include actions that may be ongoing (e.g., maintenance medications that the patient is taking, or monitoring the patient's health status or the status of an intervention). Instructions are nested within interventions and may include self-care instructions. Instructions are information or directions to the patient and other providers including how to care for the individual's condition, what to do at home, when to call for help, any additional appointments, testing, and changes to the medication list or medication instructions, clinical guidelines and a summary of best practice. Instructions are information or directions to the patient. Use the Instructions Section when instructions are included as part of a document that is not a Care Plan. Use the Interventions Section, containing the Intervention Act containing the Instruction entry, when instructions are part of a structured care plan. |
Latex Safety Observation | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to exchange the **Latex Safety Status** of the patient's medical device. The UDI-DI of the medical device may be used to retrieve the Latex Safety status in accessGUDID, which should be considered the source of truth. |
Longitudinal Care Wound Observation | hl7.cda.us.ccda#current | R5 | This template represents acquired or surgical wounds and is not intended to encompass all wound types. The template applies to wounds such as pressure ulcers, surgical incisions, and deep tissue injury wounds. Information in this template may include information about the wound measurements characteristics. |
Lot or Batch Number Observation | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to exchange the **Lot or Batch Number** of the device. The Lot or Batch Number is parsed from the UDI value, if present. |
Manufacturing Date Observation | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to exchange the **Manufacturing Date** of the device. The manufacturing date is parsed from the UDI value, if present. |
Medical (General) History Section | hl7.cda.us.ccda#current | R5 | The Medical History Section describes all aspects of the medical history of the patient even if not pertinent to the current procedure, and may include chief complaint, past medical history, social history, family history, surgical or procedure history, medication history, and other history information. The history may be limited to information pertinent to the current procedure or may be more comprehensive. The history may be reported as a collection of random clinical statements or it may be reported categorically. Categorical report formats may be divided into multiple subsections including Past Medical History, Social History. |
Medical Equipment Organizer | hl7.cda.us.ccda#current | R5 | This template represents a set of current or historical medical devices, supplies, aids and equipment used by the patient. Examples are hearing aids, orthotic devices, ostomy supplies, visual aids, diabetic supplies such as syringes and pumps, and wheelchairs. Devices that are applied during a procedure (e.g., cardiac pacemaker, gastrosomy tube, port catheter), whether permanent or temporary, are represented within the Procedure Activity Procedure (V2) template (templateId: 2.16.840.1.113883.10.20.22.4.14.2). |
Medical Equipment Section | hl7.cda.us.ccda#current | R5 | This section defines a patient's implanted and external health and medical devices and equipment. This section lists any pertinent durable medical equipment (DME) used to help maintain the patient's health status. All equipment relevant to the diagnosis, care, or treatment of a patient should be included. Devices applied to, or placed in, the patient are represented with the Procedure Activity Procedure (V2) template. Equipment supplied to the patient (e.g., pumps, inhalers, wheelchairs) is represented by the Non-Medicinal Supply Activity V2 template. These devices may be grouped together within a Medical Equipment Organizer. The organizer would probably not be used with devices applied in or on the patient but rather to organize a group of medical supplies the patient has been supplied with. |
Medication Activity | hl7.cda.us.ccda#current | R5 | A Medication Activity describes substance administrations that have actually occurred (e.g., pills ingested or injections given) or are intended to occur (e.g., "take 2 tablets twice a day for the next 10 days"). Medication activities in "INT" mood are reflections of what a clinician intends a patient to be taking. For example, a clinician may intend that a patient be administered Lisinopril 20 mg PO for blood pressure control. If what was actually administered was Lisinopril 10 mg., then the Medication activities in the "EVN" mood would reflect actual use. A moodCode of INT is allowed, but it is recommended that the Planned Medication Activity (V2) template be used for moodCodes other than EVN if the document type contains a section that includes Planned Medication Activity (V2) (for example a Care Plan document with Plan of Treatment, Intervention, or Goal sections). At a minimum, a Medication Activity shall include an effectiveTime indicating the duration of the administration (or single-administration timestamp). Ambulatory medication lists generally provide a summary of use for a given medication over time - a medication activity in event mood with the duration reflecting when the medication started and stopped. Ongoing medications will not have a stop date (or will have a stop date with a suitable NULL value). Ambulatory medication lists will generally also have a frequency (e.g., a medication is being taken twice a day). Inpatient medications generally record each administration as a separate act. The dose (doseQuantity) represents how many of the consumables are to be administered at each administration event. As a result, the dose is always relative to the consumable and the interval of administration. Thus, a patient consuming a single "metoprolol 25mg tablet" per administration will have a doseQuantity of "1", whereas a patient consuming "metoprolol" will have a dose of "25 mg". |
Medication Dispense (V3) | hl7.cda.us.ccda#current | R5 | This template records the act of supplying medications (i.e., dispensing). The moodCode equaling "EVN" (Event), signals that the "supply" has occurred and thus has been dispensed. |
Medication Free Text Sig | hl7.cda.us.ccda#current | R5 | The template is available to explicitly identify the free text Sig within each medication. An example free text sig: Thyroxin 150 ug, take one tab by mouth every morning. |
Medication Information | hl7.cda.us.ccda#current | R5 | A medication should be recorded as a pre-coordinated ingredient + strength + dose form (e.g., "metoprolol 25mg tablet", "amoxicillin 400mg/5mL suspension") where possible. This includes RxNorm codes whose Term Type is SCD (semantic clinical drug), SBD (semantic brand drug), GPCK (generic pack), BPCK (brand pack). The dose (doseQuantity) represents how many of the consumables are to be administered at each administration event. As a result, the dose is always relative to the consumable. Thus, a patient consuming a single "metoprolol 25mg tablet" per administration will have a doseQuantity of "1", whereas a patient consuming "metoprolol" will have a dose of "25 mg". |
Medication Supply Order | hl7.cda.us.ccda#current | R5 | This template records the intent to supply a patient with medications. |
Medications Administered Section | hl7.cda.us.ccda#current | R5 | The Medications Administered Section usually resides inside a Procedure Note describing a procedure. This section defines medications and fluids administered during the procedure, its related encounter, or other procedure related activity excluding anesthetic medications. Anesthesia medications should be documented as described in the Anesthesia Section templateId 2.16.840.1.113883.10.20.22.2.25. |
Medications Section | hl7.cda.us.ccda#current | R5 | The Medications Section contains a patient's current medications and pertinent medication history. At a minimum, the currently active medications are listed. An entire medication history is an option. The section can describe a patient's prescription and dispense history and information about intended drug monitoring. This section requires either an entry indicating the subject is not known to be on any medications or entries summarizing the subject's medications. |
Mental Status Observation | hl7.cda.us.ccda#current | R5 | The Mental Status Observation template represents an observation about mental status that can come from a broad range of subjective and objective information (including measured data) to address those categories described in the Mental Status Section. See also Assessment Scale Observation for specific collections of observations that together yield a summary evaluation of a particular condition. |
Mental Status Organizer | hl7.cda.us.ccda#current | R5 | The Mental Status Organizer template may be used to group related Mental Status Observations (e.g., results of mental tests) and associated Assessment Scale Observations into subcategories and/or groupings by time. Subcategories can be things such as Mood and Affect, Behavior, Thought Process, Perception, Cognition, etc. |
Mental Status Section | hl7.cda.us.ccda#current | R5 | The Mental Status Section contains observations and evaluations related to a patient's psychological and mental competency and deficits including, but not limited to any of the following types of information: * Appearance (e.g., unusual grooming, clothing or body modifications) * Attitude (e.g., cooperative, guarded, hostile) * Behavior/psychomotor (e.g., abnormal movements, eye contact, tics) * Mood and affect (e.g., anxious, angry, euphoric) * Speech and Language (e.g., pressured speech, perseveration) * Thought process (e.g., logic, coherence) * Thought content (e.g., delusions, phobias) * Perception (e.g., voices, hallucinations) * Cognition (e.g., memory, alertness/consciousness, attention, orientation) which were included in Cognitive Status Observation in earlier publications of C-CDA. * Insight and judgment (e.g., understanding of condition, decision making) |
Model Number Observation | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to exchange the **Model Number** associated with the device. The UDI-DI of the medical device may be used to retrieve the **Model Number** in accessGUDID, which should be considered the source of truth. |
MRI Safety Observation | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to exchange the MRI Safety Status of the patient's medical device. The UDI-DI of the medical device may be used to retrieve the **MRI Safety Status** in accessGUDID, which should be considered the source of truth. |
NDC Labeler Code Request Logical Model | hl7.fhir.us.spl#current | R4B | An operation to request a NDC Labeler code for a registrant or private Labeler organization. |
Non-Medicinal Supply Activity | hl7.cda.us.ccda#current | R5 | This template represents equipment supplied to the patient (e.g., pumps, inhalers, wheelchairs). Devices applied to, or placed in, the patient are represented with the Product Instance entry contained within a Procedure Activity Procedure (V2) (identifier: urn:hl7ii: 2.16.840.1.113883.10.20.22.4.14) |
Note Activity | hl7.cda.us.ccda#current | R5 | The Note Activity represents a clinical note. Notes require authorship, authentication, timing information, and references to other discrete data such as encounters. Similar to the Comment Activity, the Note Activity permits a more specific code to characterize the type of information available in the note. The Note Activity template SHOULD NOT be used in place of a more specific C-CDA entry. Note information included needs to be relevant and pertinent to the information being communicated in the document. When the note information augments data represented in a more specific entry template, the Note Activity can be used in an entryRelationship to the associated standard C-CDA entry. For example, a Procedure Note added as an entryRelationship to a Procedure Activity Procedure entry). The Note Activity template can be used as a standalone entry within a standard C-CDA section (e.g., a note about various procedures which have occurred during a visit as an entry in the Procedures Section) when it does not augment another standard entry. It may also be used to provide additional data about the source of a currently narrative-only section, such as Hospital Course. Finally, if the type of data in the note is not known or no single C-CDA section is appropriate enough, the Note Activity should be placed in a Notes Section. (e.g., a free-text consultation note or a note which includes subjective, objective, assessment, and plan information combined). An alternative is to place the Note Activity as an entryRelationship to an Encounter Activity entry in the Encounters Section, but implementers may wish to group notes categorically into a separate location in CDA documents rather than overloading the Encounters Section. |
Notes Section | hl7.cda.us.ccda#current | R5 | The Notes Section allow for inclusion of clinical documentation which does not fit precisely within any other C-CDA section. Multiple Notes sections may be included in a document provided they each include different types of note content as indicated by a different section.code. The Notes Section SHOULD NOT be used in place of a more specific C-CDA section. For example, notes about procedure should be placed within the Procedures Section, not a Notes Section. When a Notes Section is present, Note Activity entries contain structured information about the note information allowing it to be more machine processable. |
Number of Pressure Ulcers Observation | hl7.cda.us.ccda#current | R5 | This template represents the number of pressure ulcers observed at a particular stage. |
Nutrition Assessment | hl7.cda.us.ccda#current | R5 | This template represents the patient's nutrition abilities and habits including intake, diet requirements or diet followed. |
Nutrition Recommendation | hl7.cda.us.ccda#current | R5 | This template represents nutrition regimens (e.g., fluid restrictions, calorie minimum), interventions (e.g., NPO, nutritional supplements), and procedures (e.g., G-Tube by bolus, TPN by central line). It may also depict the need for nutrition education. |
Nutrition Section | hl7.cda.us.ccda#current | R5 | The Nutrition Section represents diet and nutrition information including special diet requirements and restrictions (e.g., texture modified diet, liquids only, enteral feeding). It also represents the overall nutritional status of the patient and nutrition assessment findings. |
Nutritional Status Observation | hl7.cda.us.ccda#current | R5 | This template describes the overall nutritional status of the patient including findings related to nutritional status. |
Objective Section | hl7.cda.us.ccda#current | R5 | The Objective Section contains data about the patient gathered through tests, measures, or observations that produce a quantified or categorized result. It includes important and relevant positive and negative test results, physical findings, review of systems, and other measurements and observations. |
Operative Note | hl7.cda.us.ccda#current | R5 | The Operative Note is a frequently used type of procedure note with specific requirements set forth by regulatory agencies. The Operative Note is created immediately following a surgical or other high-risk procedure. It records the pre- and post-surgical diagnosis, pertinent events of the procedure, as well as the condition of the patient following the procedure. The report should be sufficiently detailed to support the diagnoses, justify the treatment, document the course of the procedure, and provide continuity of care. |
Operative Note Fluids Section | hl7.cda.us.ccda#current | R5 | The Operative Note Fluids Section may be used to record fluids administered during the surgical procedure. |
Operative Note Surgical Procedure Section | hl7.cda.us.ccda#current | R5 | The Operative Note Surgical Procedure Section can be used to restate the procedures performed if appropriate for an enterprise workflow. The procedure(s) performed associated with the Operative Note are formally modeled in the header using serviceEvent. |
Outcome Observation | hl7.cda.us.ccda#current | R5 | This template represents the outcome of care resulting from the interventions used to treat the patient. In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal. Often thought of as an "actual outcome", the Outcome Observation may be related to goals, progression toward goals, and the associated interventions. For example, an observation outcome of a blood oxygen saturation level of 95% is related to the goal of "Maintain Pulse Ox greater than 92", which in turn is related to the health concern of respiratory insufficiency and the problem of pneumonia. The template makes use of the Entry Reference (templateId:2.16.840.1.113883.10.20.22.4.122) to reference the interventions and goals defined elsewhere in the Care Plan CDA instance. |
PAS Metric Data | hl7.fhir.us.davinci-pas#current | R4 | A logical model describing the information that should be captured by PAS implementers about every PAS invocation to support measures evaluating PAS implementation |
Past Medical History | hl7.cda.us.ccda#current | R5 | This section contains a record of the patient's past complaints, problems, and diagnoses. It contains data from the patient's past up to the patient's current complaint or reason for seeking medical care. |
Patient Referral Act | hl7.cda.us.ccda#current | R5 | This template represents the type of referral (e.g., for dental care, to a specialist, for aging problems) and represents whether the referral is for full care or shared care. It may contain a reference to another act in the document instance representing the clinical reason for the referral (e.g., problem, concern, procedure). |
Payers Section | hl7.cda.us.ccda#current | R5 | The Payers Section contains data on the patient's payers, whether "third party" insurance, self-pay, other payer or guarantor, or some combination of payers, and is used to define which entity is the responsible fiduciary for the financial aspects of a patient's care.. Each unique instance of a payer and all the pertinent data needed to contact, bill to, and collect from that payer should be included. Authorization information that can be used to define pertinent referral, authorization tracking number, procedure, therapy, intervention, device, or similar authorizations for the patient or provider, or both should be included. At a minimum, the patient's pertinent current payment sources should be listed.. The sources of payment are represented as a Coverage Activity, which identifies all of the insurance policies or government or other programs that cover some or all of the patient's healthcare expenses. The policies or programs are sequenced by preference. The Coverage Activity has a sequence number that represents the preference order. Each policy or program identifies the covered party with respect to the payer, so that the identifiers can be recorded. |
Physical Exam Section | hl7.cda.us.ccda#current | R5 | The section includes direct observations made by a clinician. The examination may include the use of simple instruments and may also describe simple maneuvers performed directly on the patient's body. It also includes observations made by the examining clinician using only inspection, palpation, auscultation, and percussion. It does not include laboratory or imaging findings. The exam may be limited to pertinent body systems based on the patient's chief complaint or it may include a comprehensive examination. The examination may be reported as a collection of random clinical statements or it may be reported categorically. The Physical Exam Section may contain multiple nested subsections. |
Plan of Treatment Section | hl7.cda.us.ccda#current | R5 | This section, formerly known as "Plan of Care", contains data that define pending orders, interventions, encounters, services, and procedures for the patient. It is limited to prospective, unfulfilled, or incomplete orders and requests only. These are indicated by the @moodCode of the entries within this section. All active, incomplete, or pending orders, appointments, referrals, procedures, services, or any other pending event of clinical significance to the current care of the patient should be listed. This section may also contain information about ongoing care of the patient, clinical reminders, patient’s values, beliefs, preferences, care expectations, and overarching care goals. Clinical reminders are placed here to provide prompts for disease prevention and management, patient safety, and healthcare quality improvements, including widely accepted performance measures. Values may include the importance of quality of life over longevity. These values are taken into account when prioritizing all problems and their treatments. Beliefs may include comfort with dying or the refusal of blood transfusions because of the patient’s religious convictions. Preferences may include liquid medicines over tablets, or treatment via secure email instead of in person. Care expectations may range from being treated only by female clinicians, to expecting all calls to be returned within 24 hours. Overarching goals described in this section are not tied to a specific condition, problem, health concern, or intervention. Examples of overarching goals could be to minimize pain or dependence on others, or to walk a daughter down the aisle for her marriage. The plan may also indicate that patient education will be provided. |
Planned Act | hl7.cda.us.ccda#current | R5 | This template represents planned acts that are not classified as an observation or a procedure according to the HL7 RIM. Examples of these acts are a dressing change, the teaching or feeding of a patient or the providing of comfort measures. The priority of the activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the activity is intended to take place. |
Planned Coverage | hl7.cda.us.ccda#current | R5 | This template represents the insurance coverage intended to cover an act or procedure. |
Planned Encounter | hl7.cda.us.ccda#current | R5 | This template represents a planned or ordered encounter. The type of encounter (e.g., comprehensive outpatient visit) is represented. Clinicians participating in the encounter and the location of the planned encounter may be captured. The priority that the patient and providers place on the encounter may be represented. |
Planned Immunization Activity | hl7.cda.us.ccda#current | R5 | This template represents planned immunizations. Planned Immunization Activity is very similar to Planned Medication Activity with some key differences, for example, the drug code system is constrained to CVX codes. The priority of the immunization activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the immunization activity is intended to take place and authorTime indicates when the documentation of the plan occurred. |
Planned Intervention Act | hl7.cda.us.ccda#current | R5 | This template represents a Planned Intervention Act. It is a wrapper for planned intervention-type activities considered to be parts of the same intervention. For example, an activity such as "elevate head of bed" combined with "provide humidified O2 per nasal cannula" may be the interventions planned for a health concern of "respiratory insufficiency" in order to attempt to achieve a goal of "pulse oximetry greater than 92%". These intervention activities may be newly described or derived from a variety of sources within an EHR. Interventions are actions taken to increase the likelihood of achieving the patient's or providers' goals. An Intervention Act should contain a reference to a Goal Observation representing the reason for the intervention. Planned Intervention Acts can be related to each other or to Intervention Acts. (E.g., a Planned Intervention Act with moodCode of INT could be related to a series of Intervention Acts with moodCode of EVN, each having an effectiveTime containing the time of the intervention.) All interventions referenced in a Planned Intervention Act must have moodCodes indicating that that are planned (have not yet occurred). |
Planned Medication Activity | hl7.cda.us.ccda#current | R5 | This template represents planned medication activities. The priority of the medication activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the medication activity is intended to take place. The authorTime indicates when the documentation of the plan occurred. |
Planned Observation | hl7.cda.us.ccda#current | R5 | This template represents planned observations that result in new information about the patient which cannot be classified as a procedure according to the HL7 RIM, i.e., procedures alter the patient's body. Examples of these observations are laboratory tests, diagnostic imaging tests, EEGs, and EKGs. The importance of the planned observation to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the observation is intended to take place and authorTime indicates when the documentation of the plan occurred. The Planned Observation template may also indicate the potential insurance coverage for the observation. |
Planned Procedure (V3) | hl7.cda.us.ccda#current | R5 | This template represents planned alterations of the patient's physical condition. Examples of such procedures are tracheostomy, knee replacement, and craniectomy. The priority of the procedure to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the procedure is intended to take place and authorTime indicates when the documentation of the plan occurred. The Planned Procedure Template may also indicate the potential insurance coverage for the procedure. Planned Procedure V3 Usage Note: Common practice in the industry has shown that Planned Procedure is the usually implemented CDA template for any type of intervention or procedure regardless of if the "immediate and primary outcome (post-condition) is the alteration of the physical condition of the patient", or not. As a result, it is recommended to use Planned Procedure when sending procedures also thought of as "interventions" such as "Home Environment Evaluation" or "Assessment of nutritional status". |
Planned Procedure Section | hl7.cda.us.ccda#current | R5 | This section contains the procedure(s) that a clinician planned based on the preoperative assessment. |
Planned Supply | hl7.cda.us.ccda#current | R5 | This template represents both medicinal and non-medicinal supplies ordered, requested, or intended for the patient (e.g., medication prescription, order for wheelchair). The importance of the supply order or request to the patient and provider may be indicated in the Priority Preference. The effective time indicates the time when the supply is intended to take place and author time indicates when the documentation of the plan occurred. The Planned Supply template may also indicate the potential insurance coverage for the procedure. Depending on the type of supply, the product or participant will be either a Medication Information product (medication), an Immunization Medication Information product (immunization), or a Product Instance participant (device/equipment). |
Policy Activity (V4) | hl7.cda.us.ccda#current | R5 | A policy activity represents the policy or program providing the coverage. The person for whom payment is being provided (i.e., the patient) is the covered party. The subscriber of the policy or program is represented as a participant that is the holder of the coverage. The payer is represented as the performer of the policy activity. |
Postoperative Diagnosis Section | hl7.cda.us.ccda#current | R5 | The Postoperative Diagnosis Section records the diagnosis or diagnoses discovered or confirmed during the surgery. Often it is the same as the preoperative diagnosis. |
Postprocedure Diagnosis | hl7.cda.us.ccda#current | R5 | This template represents the diagnosis or diagnoses discovered or confirmed during the procedure. They may be the same as preprocedure diagnoses or indications. |
Postprocedure Diagnosis Section | hl7.cda.us.ccda#current | R5 | The Postprocedure Diagnosis Section records the diagnosis or diagnoses discovered or confirmed during the procedure. Often it is the same as the preprocedure diagnosis or indication. |
Precondition for Substance Administration | hl7.cda.us.ccda#current | R5 | A criterion for administration can be used to record that the medication is to be administered only when the associated criteria are met. |
Pregnancy Intention in Next Year | hl7.cda.us.ccda#current | R5 | This template represents a patient's reported intention or desire in the next year to either become pregnant or prevent a future pregnancy. The effectiveTime.low represents the date the intention was recorded and the effectiveTime.high represents the date a year from the recorded date. |
Pregnancy Observation | hl7.cda.us.ccda#current | R5 | This clinical statement represents current and/or prior pregnancy dates enabling investigators to determine if the subject of the case report was pregnant during the course of a condition. |
Preoperative Diagnosis | hl7.cda.us.ccda#current | R5 | This template represents the surgical diagnosis or diagnoses assigned to the patient before the surgical procedure and is the reason for the surgery. The preoperative diagnosis is, in the opinion of the surgeon, the diagnosis that will be confirmed during surgery. |
Preoperative Diagnosis Section | hl7.cda.us.ccda#current | R5 | The Preoperative Diagnosis Section records the surgical diagnoses assigned to the patient before the surgical procedure which are the reason for the surgery. The preoperative diagnosis is, in the surgeon's opinion, the diagnosis that will be confirmed during surgery. |
Pressure Ulcer Observation (DEPRECATED) | hl7.cda.us.ccda#current | R5 | The pressure ulcer observation contains details about the pressure ulcer such as the stage of the ulcer, location, and dimensions. If the pressure ulcer is a diagnosis, you may find this on the problem list. An example of how this would appear is in the Problem Section. THIS TEMPLATE HAS BEEN DEPRECATED IN C-CDA R2 AND MAY BE DELETED FROM A FUTURE RELEASE OF THIS IMPLEMENTATION GUIDE. USE OF THIS TEMPLATE IS NOT RECOMMENDED. *Reason for deprecation*: This template has been replaced by Longitudinal Care Wound Observation (2.16.840.1.113883.10.20.22.4.114). |
Priority Preference | hl7.cda.us.ccda#current | R5 | This template represents priority preferences chosen by a patient or a care provider. Priority preferences are choices made by care providers or patients or both relative to options for care or treatment (including scheduling, care experience, and meeting of personal health goals), the sharing and disclosure of health information, and the prioritization of concerns and problems. |
Problem Concern Act | hl7.cda.us.ccda#current | R5 | This template reflects an ongoing concern on behalf of the provider that placed the concern on a patient's problem list. So long as the underlying condition is of concern to the provider (i.e., as long as the condition, whether active or resolved, is of ongoing concern and interest to the provider), the statusCode is "active". Only when the underlying condition is no longer of concern is the statusCode set to "completed". The effectiveTime reflects the time that the underlying condition was felt to be a concern; it may or may not correspond to the effectiveTime of the condition (e.g., even five years later, the clinician may remain concerned about a prior heart attack). The statusCode of the Problem Concern Act is the definitive indication of the status of the concern, whereas the effectiveTime of the nested Problem Observation is the definitive indication of whether or not the underlying condition is resolved. The effectiveTime/low of the Problem Concern Act asserts when the concern became active. The effectiveTime/high asserts when the concern was completed (e.g., when the clinician deemed there is no longer any need to track the underlying condition). A Problem Concern Act can contain many Problem Observations (templateId 2.16.840.1.113883.10.20.22.4.4). Each Problem Observation is a discrete observation of a condition, and therefore will have a statusCode of "completed". The many Problem Observations nested under a Problem Concern Act reflect the change in the clinical understanding of a condition over time. For instance, a Concern may initially contain a Problem Observation of "chest pain": - Problem Concern 1 --- Problem Observation: Chest Pain Later, a new Problem Observation of "esophagitis" will be added, reflecting a better understanding of the nature of the chest pain. The later problem observation will have a more recent author time stamp. - Problem Concern 1 --- Problem Observation (author/time Jan 3, 2012): Chest Pain --- Problem Observation (author/time Jan 6, 2012): Esophagitis Many systems display the nested Problem Observation with the most recent author time stamp, and provide a mechanism for viewing prior observations. |
Problem Observation | hl7.cda.us.ccda#current | R5 | This template reflects a discrete observation about a patient's problem. Because it is a discrete observation, it will have a statusCode of "completed". The effectiveTime, also referred to as the "biologically relevant time" is the time at which the observation holds for the patient. For a provider seeing a patient in the clinic today, observing a history of heart attack that occurred five years ago, the effectiveTime is five years ago. The effectiveTime of the Problem Observation is the definitive indication of whether or not the underlying condition is resolved. If the problem is known to be resolved, then an effectiveTime/high would be present. If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of "UNK". |
Problem Section | hl7.cda.us.ccda#current | R5 | This section lists and describes all relevant clinical problems at the time the document is generated. At a minimum, all pertinent current and historical problems should be listed. Overall health status may be represented in this section. |
Problem Status | hl7.cda.us.ccda#current | R5 | The Problem Status records the clinical status attributed to the problem. |
Procedure Activity Act | hl7.cda.us.ccda#current | R5 | This template represents any act that cannot be classified as an observation or procedure according to the HL7 RIM. Examples of these acts are a dressing change, teaching or feeding a patient, or providing comfort measures. The common notion of "procedure" is broader than that specified by the HL7 Version 3 Reference Information Model (RIM). Procedure templates can be represented with various RIM classes: act (e.g., dressing change), observation (e.g., EEG), procedure (e.g., splenectomy). |
Procedure Activity Observation | hl7.cda.us.ccda#current | R5 | The common notion of procedure is broader than that specified by the HL7 Version 3 Reference Information Model (RIM). Therefore procedure templates can be represented with various RIM classes: act (e.g., dressing change), observation (e.g., EEG), procedure (e.g., splenectomy). This template represents procedures that result in new information about the patient that cannot be classified as a procedure according to the HL7 RIM. Examples of these procedures are diagnostic imaging procedures, EEGs, and EKGs. |
Procedure Activity Procedure (V3) | hl7.cda.us.ccda#current | R5 | The common notion of "procedure" is broader than that specified by the HL7 Version 3 Reference Information Model (RIM). Therefore procedure templates can be represented with various RIM classes: act (e.g., dressing change), observation (e.g., EEG), procedure (e.g., splenectomy). This template represents procedures whose immediate and primary outcome (post-condition) is the alteration of the physical condition of the patient. Examples of these procedures are an appendectomy, hip replacement, and a creation of a gastrostomy. This template can be used with a contained Product Instance template to represent a device in or on a patient. In this case, targetSiteCode is used to record the location of the device in or on the patient's body. Equipment supplied to the patient (e.g., pumps, inhalers, wheelchairs) is represented by the Non-Medicinal Supply Activity (V2) template. Procedure Activity Procedure V3 Usage Note: Common practice in the industry has shown that Procedure Activity Procedure is the usually implemented CDA template for any type of intervention or procedure regardless of if the "immediate and primary outcome (post-condition) is the alteration of the physical condition of the patient" or not. As a result, it is recommended to use Procedure Activity Procedure when sending procedures also thought of as "interventions" such as "Home Environment Evaluation" or "Assessment of nutritional status". |
Procedure Description Section | hl7.cda.us.ccda#current | R5 | The Procedure Description section records the particulars of the procedure and may include procedure site preparation, surgical site preparation, pertinent details related to sedation/anesthesia, pertinent details related to measurements and markings, procedure times, medications administered, estimated blood loss, specimens removed, implants, instrumentation, sponge counts, tissue manipulation, wound closure, sutures used, vital signs and other monitoring data. Local practice often identifies the level and type of detail required based on the procedure or specialty. |
Procedure Disposition Section | hl7.cda.us.ccda#current | R5 | The Procedure Disposition Section records the status and condition of the patient at the completion of the procedure or surgery. It often also states where the patient was transferred to for the next level of care. |
Procedure Estimated Blood Loss Section | hl7.cda.us.ccda#current | R5 | The Procedure Estimated Blood Loss Section may be a subsection of another section such as the Procedure Description Section. The Procedure Estimated Blood Loss Section records the approximate amount of blood that the patient lost during the procedure or surgery. It may be an accurate quantitative amount, e.g., 250 milliliters, or it may be descriptive, e.g., minimal or none. |
Procedure Findings Section | hl7.cda.us.ccda#current | R5 | The Procedure Findings Section records clinically significant observations confirmed or discovered during a procedure or surgery. |
Procedure Implants Section | hl7.cda.us.ccda#current | R5 | The Procedure Implants Section records any materials placed during the procedure including stents, tubes, and drains. |
Procedure Indications Section | hl7.cda.us.ccda#current | R5 | This section contains the reason(s) for the procedure or surgery. This section may include the preprocedure diagnoses as well as symptoms contributing to the reason for the procedure. |
Procedure Note | hl7.cda.us.ccda#current | R5 | A Procedure Note encompasses many types of non-operative procedures including interventional cardiology, gastrointestinal endoscopy, osteopathic manipulation, and many other specialty fields. Procedure Notes are differentiated from Operative Notes because they do not involve incision or excision as the primary act. The Procedure Note is created immediately following a non-operative procedure. It records the indications for the procedure and, when applicable, postprocedure diagnosis, pertinent events of the procedure, and the patient's tolerance for the procedure. It should be detailed enough to justify the procedure, describe the course of the procedure, and provide continuity of care. |
Procedure Specimens Taken Section | hl7.cda.us.ccda#current | R5 | The Procedure Specimens Taken Section records the tissues, objects, or samples taken from the patient during the procedure including biopsies, aspiration fluid, or other samples sent for pathological analysis. The narrative may include a description of the specimens. |
Procedures Section | hl7.cda.us.ccda#current | R5 | This section describes all interventional, surgical, diagnostic, or therapeutic procedures or treatments pertinent to the patient historically at the time the document is generated. The section should include notable procedures, but can contain all procedures for the period of time being summarized. The common notion of "procedure" is broader than that specified by the HL7 Version 3 Reference Information Model (RIM), therefore this section contains procedure templates represented with three RIM classes: Act, Observation, and Procedure. Procedure Activity Procedure (V2) is for procedures that alter the physical condition of a patient (e.g., splenectomy). Procedure Activity Observation (V2) is for procedures that result in new information about a patient but do not cause physical alteration (e.g., EEG). Procedure Activity Act (V2) is for all other types of procedures (e.g., dressing change). |
Product Instance | hl7.cda.us.ccda#current | R5 | This clinical statement represents a particular device that was placed in a patient or used as part of a procedure or other act. This provides a record of the identifier and other details about the given product that was used. For example, it is important to have a record that indicates not just that a hip prostheses was placed in a patient but that it was a particular hip prostheses number with a unique identifier. The FDA Amendments Act specifies the creation of a Unique Device Identification (UDI) System that requires the label of devices to bear a unique identifier that will standardize device identification and identify the device through distribution and use. The FDA permits an issuing agency to designate that their Device Identifier (DI) + Production Identifier (PI) format qualifies as a UDI through a process of accreditation. Currently, there are three FDA-accredited issuing agencies that are allowed to call their format a UDI. These organizations are GS1, HIBCC, and ICCBBA. For additional information on technical formats that qualify as UDI from each of the issuing agencies see the UDI Appendix. When communicating only the issuing agency device identifier (i.e., subcomponent of the UDI), the use of the issuing agency OID is appropriate. However, when communicating the unique device identifier (DI + PI), the FDA OID (2.16.840.1.113883.3.3719) must be used. When sending a UDI, populate the participantRole/id/@root with the FDA OID (2.16.840.1.113883.3.3719) and participantRole/id/@extension with the UDI. When sending a DI, populate the participantRole/id/@root with the appropriate assigning agency OID and participantRole/id/@extension with the DI. The scopingEntity/id should correspond to FDA or the appropriate issuing agency. |
Product Submission Document Logical Model | hl7.fhir.us.spl#current | R4B | A document that contains information about a product being submitted for approval to the FDA. |
Prognosis Observation | hl7.cda.us.ccda#current | R5 | This template represents the patient's prognosis, which must be associated with a problem observation. It may serve as an alert to scope intervention plans. The effectiveTime represents the clinically relevant time of the observation. The observation/value is not constrained and can represent the expected life duration in PQ, an anticipated course of the disease in text, or coded term. |
Progress Note | hl7.cda.us.ccda#current | R5 | This template represents a patient's clinical status during a hospitalization, outpatient visit, treatment with a LTPAC provider, or other healthcare encounter. Taber's medical dictionary defines a Progress Note as "An ongoing record of a patient's illness and treatment. Physicians, nurses, consultants, and therapists record their notes concerning the progress or lack of progress made by the patient between the time of the previous note and the most recent note." Mosby's medical dictionary defines a Progress Note as "Notes made by a nurse, physician, social worker, physical therapist, and other health care professionals that describe the patient's condition and the treatment given or planned." A Progress Note is not a re-evaluation note. A Progress Note is not intended to be a Progress Report for Medicare. Medicare B Section 1833(e) defines the requirements of a Medicare Progress Report. |
Progress Toward Goal Observation | hl7.cda.us.ccda#current | R5 | This template represents a patient's progress toward a goal. It can describe whether a goal has been achieved or not and can also describe movement a patient is making toward the achievement of a goal (e.g., "Goal not achieved - no discernible change", "Goal not achieved - progressing toward goal", "Goal not achieved - declining from goal"). In the Care Planning workflow, the judgment about how well the person is progressing towards the goal is based on the observations made about the status of the patient with respect to interventions performed in the pursuit of achieving that goal. For example, an observation outcome of a blood oxygen saturation level of 95% is related to the goal of "Maintain Pulse Ox greater than 92" and in this case the Progress Toward Goal Observation template would record that the related goal has been achieved. |
Provenance - Assembler Participation (V2) | hl7.cda.us.ccda#current | R5 | This template represents the organization that supported generation of a CDA document. The Assembler Organization may be different than the Author Organization, and may be different from the Organization that developed the software used to generate the document. This Participation is only for use in the CDA Header because it applies to the entire content in the document. This template is consistent with the prior Assembler Document Participant (2.16.840.1.113883.3.5019.1.1) in the 2016 HL7 Data Provenance guide, however, makes no claim about representing the software organization. All constraints for conformance are defined in this template. Note: The CDA Participant does not support a software device or the organization that created the software. The Assembler role can only be expressed at the level of organization. This is a known issue with the current CDA R2 model. Note: The Provenance template title includes a version 2 to support moving from the 'Basic Provenance' guide to the this Companion Guide, so the templateId has not changed. |
Provenance - Author Participation (V2) | hl7.cda.us.ccda#current | R5 | This template represents the key information to record Provenance in an Author Participation. This Participation is appropriate at any place CDA allows an author. For example, at the CDA Header, CDA Section, CDA Entry, or within a CDA entry (e.g. Organizer and contained Observation(s)). This template is consistent with the C-CDA Author Participation, however, it doesnt use a formal conforms to relationship. All constraints for conformance are defined in this template which specializes the Author Participation (2.16.840.1.113883.10.20.22.4.119). This template is used to identify primary authorship for an entry. An entry may have many authors, but recipients need a single authoritative point of contact for resolving issues. This is typically the last provider to make substantive changes to the entry If two providers are simultaneously involved in that activity, the implementer must choose one, ideally in a repeatable way. The `assignedAuthor/id` may be set equal to (a pointer to) an id on a participant elsewhere in the document (header or entries) or a new author participant can be described here. Note: The Provenance template title includes a version 2 to support moving from the 'Basic Provenance' guide to the this Companion Guide, so the templateId has not changed. |
Reaction Observation | hl7.cda.us.ccda#current | R5 | This clinical statement represents the response to an undesired symptom, finding, etc. due to administered or exposed substance. A reaction can be defined described with respect to its severity, and can have been treated by one or more interventions. |
Reason (V4) | hl7.cda.us.ccda#current | R5 | This template describes the thought process or justification for an action or for not performing an action. Examples include patient, system, or non-problem/diagnosis medical-related reasons for declining to perform specific actions, or any reason for performing an action. Note that the parent template that calls this template can be asserted to have occurred or to not have occurred. Therefore, this template simply adds a reason to some other (possibly negated) act. As such, there is nothing in this template that says whether the parent act did or did not occur. It is expected that the primary use of this template within C-CDA is to provide the rationale for why something was not done. If this template is called by a template that is not negated, the Reason template should contain something other than a problem or a diagnosis, such as a patient preference. The Indication (V3) observation: 2.16.840.1.113883.10.20.22.4.19 should be used to represent a diagnosis or problem to indicate the diagnosis or problem is the rationale for an action. Immunization Refusal Reason: 2.16.840.1.113883.10.20.22.4.53 should be used to represent the rationale for the patient declining an immunization as the value set is crafted for the immunization use case. |
Reason for Referral Section | hl7.cda.us.ccda#current | R5 | This section describes the clinical reason why a provider is sending a patient to another provider for care. The reason for referral may become the reason for visit documented by the receiving provider. |
Reason for Visit Section | hl7.cda.us.ccda#current | R5 | This section records the patient's reason for the patient's visit (as documented by the provider). Local policy determines whether Reason for Visit and Chief Complaint are in separate or combined sections. |
Referral Note | hl7.cda.us.ccda#current | R5 | A Referral Note communicates pertinent information from a provider who is requesting services of another provider of clinical or non-clinical services. The information in this document includes the reason for the referral and additional information that would augment decision making and care delivery. Examples of referral situations are when a patient is referred from a family physician to a cardiologist for cardiac evaluation or when patient is sent by a cardiologist to an emergency department for angina or when a patient is referred by a nurse practitioner to an audiologist for hearing screening or when a patient is referred by a hospitalist to social services. |
Related Person Relationship and Name Participant | hl7.cda.us.ccda#current | R5 | This template represents a generic participant person that has a relationship to the patient. (e.g., parent, next-of-kin, neighbor). The related person's name is required and it is recommended that the person's contact information is present. The more specific CDA participant of Guardian (recordTarget/patientRole/patient/guardian) can be used to represent a legally responsible guardian of the patient within the header. This template may be used to represent a person with any relationship to the patient within the header, or at the entry level when pertinent to a particular clinical statement. |
Result Observation (V4) | hl7.cda.us.ccda#current | R5 | This template represents the results of a laboratory, radiology, or other study performed on a patient. The result observation includes a statusCode to allow recording the status of an observation. Pending results (e.g., a test has been run but results have not been reported yet) should be represented as active ActStatus. |
Result Organizer (V4) | hl7.cda.us.ccda#current | R5 | This template provides a mechanism for grouping result observations. It contains information applicable to all of the contained result observations. The Result Organizer code categorizes the contained results into one of several commonly accepted values (e.g., Hematology, Chemistry, Nuclear Medicine). If any Result Observation within the organizer has a statusCode of "active", the Result Organizer must also have a statusCode of "active". |
Results Section | hl7.cda.us.ccda#current | R5 | The Results Section contains observations of results generated by laboratories, imaging procedures, and other procedures. These coded result observations are contained within a Results Organizer in the Results Section. The scope includes observations such as hematology, chemistry, serology, virology, toxicology, microbiology, plain x-ray, ultrasound, CT, MRI, angiography, echocardiography, nuclear medicine, pathology, and procedure observations. The section often includes notable results such as abnormal values or relevant trends, and could contain all results for the period of time being documented. Laboratory results are typically generated by laboratories providing analytic services in areas such as chemistry, hematology, serology, histology, cytology, anatomic pathology, microbiology, and/or virology. These observations are based on analysis of specimens obtained from the patient and submitted to the laboratory. Imaging results are typically generated by a clinician reviewing the output of an imaging procedure, such as where a cardiologist reports the left ventricular ejection fraction based on the review of a cardiac echocardiogram. Procedure results are typically generated by a clinician to provide more granular information about component observations made during a procedure, such as where a gastroenterologist reports the size of a polyp observed during a colonoscopy. |
Review of Systems Section | hl7.cda.us.ccda#current | R5 | The Review of Systems Section contains a relevant collection of symptoms and functions systematically gathered by a clinician. It includes symptoms the patient is currently experiencing, some of which were not elicited during the history of present illness, as well as a potentially large number of pertinent negatives, for example, symptoms that the patient denied experiencing. |
Risk Concern Act | hl7.cda.us.ccda#current | R5 | This template represents a risk concern. It is a wrapper for a single risk concern which may be derived from a variety of sources within an EHR (such as Problem List, Family History, Social History, Social Worker Note, etc.). A Risk Concern Act represents a health concern that is a risk. A risk is a clinical or socioeconomic condition that the patient does not currently have, but the probability of developing that condition rises to the level of concern such that an intervention and/or monitoring is needed. |
Section Time Range Observation | hl7.cda.us.ccda#current | R5 | This observation represents the date and time range of the information contained in a section. It is an optional entry and may be used in any section. |
Self-Care Activities (ADL and IADL) | hl7.cda.us.ccda#current | R5 | This template represents a patient's daily self-care ability. These activities are called Activities of Daily Living (ADL) and Instrumental Activities of Daily Living (IADL). ADLs involve caring for and moving of the body (e.g., dressing, bathing, eating). IADLs support an independent life style (e.g., cooking, managing medications, driving, shopping). |
Sensory Status | hl7.cda.us.ccda#current | R5 | This template represents a patient's sensory or speech ability. It may contain an assessment scale observations related to the sensory or speech ability. |
Serial Number Observation | hl7.cda.us.ccda#current | R5 | This template is intended to be used in addition to the **Product Instance** template urn:oid:2.16.840.1.113883.10.20.22.4.37 to exchange the **Serial Number** of the device. The serial number is parsed from the UDI value, if present. |
Service Delivery Location | hl7.cda.us.ccda#current | R5 | This clinical statement represents the location of a service event where an act, observation or procedure took place. |
Severity Observation | hl7.cda.us.ccda#current | R5 | This clinical statement represents the gravity of the problem, such as allergy or reaction, in terms of its actual or potential impact on the patient. The Severity Observation can be associated with an Allergy - Intolerance Observation, Substance or Device Allergy - Intolerance Observation, Reaction Observation or all. When the Severity Observation is associated directly with an allergy it characterizes the allergy. When the Severity Observation is associated with a Reaction Observation it characterizes a reaction. A person may manifest many symptoms in a reaction to a single substance, and each reaction to the substance can be represented. However, each reaction observation can have only one severity observation associated with it. For example, someone may have a rash reaction observation as well as an itching reaction observation, but each can have only one level of severity. |
Sex Observation | hl7.cda.us.ccda#current | R5 | This template represents sex notations that occur in various instances, such as encounters that reflect information derived from driver's licenses or other IDs and meets the USCDI V4 Data element Sex. The Birth Sex Observation template is available for use in C-CDA and reflects specifically the sex assigned at birth concept present in USCDI V1 and V2. This Sex observation MAY also mean sex at the time of birth if it was documented at the time of delivery. Future versions of the template be informed by the content of the HL7 Cross Paradigm IG: Gender Harmony - Sex and Gender Representation 1.0.0. when published. It is recommended systems include the Sex Observation in the Social History section. |
Sexual Orientation Observation (V2) | hl7.cda.us.ccda#current | R5 | This observation represents the sexual orientation of the patient, defined as: > A persons identification of their emotional, romantic, sexual, or affectional attraction to another person. This template was informed by the HL7 Gender Harmony project. This observation is not appropriate for recording patient gender (administrativeGender), Gender Identity (Gender Identity Observation), or birth sex (Birth Sex Observation). |
Smoking Status - Meaningful Use | hl7.cda.us.ccda#current | R5 | This template represents the current smoking status of the patient as specified in Meaningful Use (MU) Stage 2 requirements. Historic smoking status observations as well as details about the smoking habit (e.g., how many per day) would be represented in the Tobacco Use template. This template represents a "snapshot in time" observation, simply reflecting what the patient's current smoking status is at the time of the observation. As a result, the effectiveTime is constrained to a time stamp, and will approximately correspond with the author/time. Details regarding the time period when the patient is/was smoking would be recorded in the Tobacco Use template. If the patient's current smoking status is unknown, the value element must be populated with SNOMED CT code 266927001 to communicate "Unknown if ever smoked" from the Current Smoking Status Value Set. |
Social History Observation (V4) | hl7.cda.us.ccda#current | R5 | This template represents a patient's job (occupation and industry), lifestyle, and environmental health risk factors. Demographic data (e.g., marital status, race, ethnicity, religious affiliation) are captured in the header. Though tobacco use and exposure may be represented with a Social History Observation, it is recommended to use the Current Smoking Status template or the Tobacco Use template instead, to represent smoking or tobacco habits. There are supplemental templates and guidance for observations of [Occupational Data for Health](https://www.hl7.org/implement/standards/product_brief.cfm?product_id=522), [nutrition](https://www.hl7.org/implement/standards/product_brief.cfm?product_id=478) and [pregnancy](https://www.hl7.org/implement/standards/product_brief.cfm?product_id=494) that could be captured in the Social History Observation, and implementers may want to consider using those more specific templates in the Social History section. |
Social History Section | hl7.cda.us.ccda#current | R5 | This section contains social history data that influence a patient's physical, psychological or emotional health (e.g., smoking status, pregnancy). Demographic data, such as marital status, race, ethnicity, and religious affiliation, is captured in the header. |
Subjective Section | hl7.cda.us.ccda#current | R5 | The Subjective Section describes in a narrative format the patient's current condition and/or interval changes as reported by the patient or by the patient's guardian or another informant. |
Submitted Medication Logical Model | hl7.fhir.us.spl#current | R4B | Details about the Medication that is submitted to the FDA. |
Substance Administered Act | hl7.cda.us.ccda#current | R5 | This template represents the administration course in a series. The entryRelationship/sequenceNumber in the containing template shows the order of this particular administration in that medication series. |
Substance or Device Allergy - Intolerance Observation (V2) | hl7.cda.us.ccda#current | R5 | This template reflects a discrete observation about a patient's allergy or intolerance to a substance or device. Because it is a discrete observation, it will have a statusCode of "completed". The effectiveTime, also referred to as the 'clinically relevant time' is the time at which the observation holds for the patient. For a provider seeing a patient in the clinic today, observing a history of penicillin allergy that developed five years ago, the effectiveTime is five years ago. The effectiveTime of the Substance or Device Allergy - Intolerance Observation is the definitive indication of whether or not the underlying allergy/intolerance is resolved. If known to be resolved, then an effectiveTime/high would be present. If the date of resolution is not known, then effectiveTime/high will be present with a nullFlavor of "UNK". |
Surgery Description Section (DEPRECATED) | hl7.cda.us.ccda#current | R5 | THIS TEMPLATE HAS BEEN DEPRECATED IN C-CDA R2 AND MAY BE DELETED FROM A FUTURE RELEASE OF THIS IMPLEMENTATION GUIDE. USE OF THIS TEMPLATE IS NOT RECOMMENDED. *Reason for deprecation*: This template has been replaced by the Procedure Description Section (2.16.840.1.113883.10.20.22.2.27). |
Surgical Drains Section | hl7.cda.us.ccda#current | R5 | The Surgical Drains Section may be used to record drains placed during the surgical procedure. Optionally, surgical drain placement may be represented with a text element in the Procedure Description Section. |
Tobacco Use | hl7.cda.us.ccda#current | R5 | This template represents a patient's tobacco use. All the types of tobacco use are represented using the codes from the tobacco use and exposure-finding hierarchy in SNOMED CT, including codes required for recording smoking status in Meaningful Use Stage 2. The effectiveTime element is used to describe dates associated with the patient's tobacco use. Whereas the Smoking Status - Meaningful Use (V2) template (2.16.840.1.113883.10.20.22.4.78:2014-06-09) represents a "snapshot in time" observation, simply reflecting what the patient's current smoking status is at the time of the observation, this Tobacco Use template uses effectiveTime to represent the biologically relevant time of the observation. Thus, to record a former smoker, an observation of "cigarette smoker" will have an effectiveTime/low defining the time the patient started to smoke cigarettes and an effectiveTime/high defining the time the patient ceased to smoke cigarettes. To record a current smoker, the effectiveTime/low will define the time the patient started smoking and will have no effectiveTime/high to indicated that the patient is still smoking. |
Transfer Summary | hl7.cda.us.ccda#current | R5 | This document describes constraints on the Clinical Document Architecture (CDA) header and body elements for a Transfer Summary. The Transfer Summary standardizes critical information for exchange of information between providers of care when a patient moves between health care settings. Standardization of information used in this form will promote interoperability; create information suitable for reuse in quality measurement, public health, research, and for reimbursement. |
Tribal Affiliation Observation | hl7.cda.us.ccda#current | R5 | This template represents the tribe or band that an individual associates with, within the United States. It is recommended systems include the Tribal Affiliation Observation in the Social History section. The tribe or band name is drawn from an HL7 code system that aligns with the Indian entities list, a list of tribes or bands recognized by and eligible to receive services from the United States Bureau of Indian Affairs. This template does not represent tribal enrollment. Please see [Indian Entities Recognized by and Eligible To Receive Services From the United States Bureau of Indian Affairs](https://www.federalregister.gov/documents/2021/01/29/2021-01606/indian-entities-recognized-by-and-eligible-to-receive-services-from-the-united-states-bureau-of). |
UDI Organizer | hl7.cda.us.ccda#current | R5 | This template is nested in an entryRelationship/Procedure Activity Procedure to record all the UDI-related templates to exchange the parsed UDI data elements and associated data. * **Device Identifier** urn:hl7ii:2.16.840.1.113883.10.20.22.4.304: 2019-06-21 NCIt: C101722 SHALL be included in UDI Organizer * **Lot or Batch Number** urn:hl7ii:2.16.840.1.113883.10.20.22.4.315: 2019-06-21 NCIt:C101672 SHOULD be included in UDI Organizer if present in UDI * **Serial Number** urn:hl7ii:2.16.840.1.113883.10.20.22.4.319: 2019-06-21 NCIt: C101671 SHOULD be included in UDI Organizer if present in UDI * **Manufacturing Date** urn:hl7ii:2.16.840.1.113883.10.20.22.4.316: 2019-06-21 NCIt:C101669 SHOULD be included in UDI Organizer if present in UDI * **Expiration Date** urn:hl7ii:2.16.840.1.113883.10.20.22.4.309: 2019-06-21 NCIt: C101670 SHOULD be included in UDI Organizer if present in UDI * **Distinct Identification Code** urn:hl7ii:2.16.840.1.113883.10.20.22.4.308: 2019-06-21 NCIt: C113843 SHOULD be included in UDI Organizer if present in UDI * **Brand Name** urn:hl7ii:2.16.840.1.113883.10.20.22.4.301: 2019-06-21 NCIt: C71898 MAY be included in the UDI Organizer if available * **Model Number** urn:hl7ii:2.16.840.1.113883.10.20.22.4.317: 2019-06-21 NCIt: C99285 MAY be included in the UDI Organizer if available * **Catalog Number** urn:hl7ii:2.16.840.1.113883.10.20.22.4.302: 2019-06-21 NCIt: C99286 MAY be included in the UDI Organizer if available * **Company Name** urn:hl7ii:2.16.840.1.113883.10.20.22.4.303: 2019-06-21 NCIt: C54131 MAY be included in the UDI Organizer if available * **MRI Safety** urn:hl7ii:2.16.840.1.113883.10.20.22.4.318: 2019-06-21 NCIt: C106044 MAY be included in the UDI Organizer if available * **Latex Safety** urn:hl7ii:2.16.840.1.113883.10.20.22.4.314: 2019-06-21 NCIt: C160938 MAY be included in the UDI Organizer if available * **Implantable Device Status** urn:hl7ii:2.16.840.1.113883.10.20.22.4.305 2019-06-21 NCIt: C160939 MAY be included in the UDI Organizer if available |
Unstructured Document | hl7.cda.us.ccda#current | R5 | An Unstructured Document (UD) document type can (1) include unstructured content, such as a graphic, directly in a text element with a mediaType attribute, or (2) reference a single document file, such as a word-processing document using a text/reference element. For guidance on how to handle multiple files, on the selection of media types for this IG, and on the identification of external files, see the examples that follow the constraints below. IHEs XDS-SD (Cross-Transaction Specifications and Content Specifications, Scanned Documents Module) profile addresses a similar, more restricted use case, specifically for scanned documents or documents electronically created from existing text sources, and limits content to PDF-A or text. This Unstructured Documents template is applicable not only for scanned documents in non-PDF formats, but also for clinical documents produced through word processing applications, etc. For conformance with both specifications, implementers need to ensure that their documents at a minimum conform with the SHALL constraints from either specification. |
US Realm Address (AD.US.FIELDED) | hl7.cda.us.ccda#current | R5 | Reusable address template, for use in US Realm CDA Header. |
US Realm Date and Time (DT.US.FIELDED) | hl7.cda.us.ccda#current | R5 | The US Realm Clinical Document Date and Time datatype flavor records date and time information. If no time zone offset is provided, you can make no assumption about time, unless you have made a local exchange agreement. This data type uses the same rules as US Realm Date and Time (DTM.US.FIELDED), but is used with elements having a datatype of IVL_TS. |
US Realm Date and Time (DTM.US.FIELDED) | hl7.cda.us.ccda#current | R5 | The US Realm Clinical Document Date and Time datatype flavor records date and time information. If no time zone offset is provided, you can make no assumption about time, unless you have made a local exchange agreement. This data type uses the same rules as US Realm Date and Time (DT.US.FIELDED), but is used with elements having a datatype of TS. |
US Realm Header (V4) | hl7.cda.us.ccda#current | R5 | This template defines constraints that represent common administrative and demographic concepts for US Realm CDA documents. Further specification, such as ClinicalDocument/code, are provided in document templates that conform to this template. |
US Realm Header for Patient Generated Document | hl7.cda.us.ccda#current | R5 | This template is designed to be used in conjunction with the US Realm Header (V2). It includes additional conformances which further constrain the US Realm Header (V2). The Patient Generated Document Header template is not a separate document type. The document body may contain any structured or unstructured content from C-CDA. |
US Realm Patient Name (PTN.US.FIELDED) | hl7.cda.us.ccda#current | R5 | The US Realm Patient Name datatype flavor is a set of reusable constraints that can be used for the patient or any other person. It requires a first (given) and last (family) name. If a patient or person has only one name part (e.g., patient with first name only) place the name part in the field required by the organization. Use the appropriate nullFlavor, "Not Applicable" (NA), in the other field. For information on mixed content see the Extensible Markup Language reference (http://www.w3c.org/TR/2008/REC-xml-20081126/). |
US Realm Person Name (PN.US.FIELDED) | hl7.cda.us.ccda#current | R5 | The US Realm Clinical Document Person Name datatype flavor is a set of reusable constraints that can be used for Persons. |
Vital Sign Observation | hl7.cda.us.ccda#current | R5 | This template represents measurement of common vital signs. Vital signs are represented with additional vocabulary constraints for type of vital sign and unit of measure. The following is a list of recommended units for common types of vital sign measurements: | Name | Unit | | -------- | ------- | | PulseOx | % | | Height/Head Circumf | cm | | Weight | kg | | Temp | Cel | | BP | mm[Hg] | | Pulse/Resp Rate | /min | | BMI | kg/m2 | | BSA | m2 | | inhaled oxygen concentration | % | |
Vital Signs Organizer | hl7.cda.us.ccda#current | R5 | This template provides a mechanism for grouping vital signs (e.g., grouping systolic blood pressure and diastolic blood pressure). |
Vital Signs Section | hl7.cda.us.ccda#current | R5 | The Vital Signs Section contains relevant vital signs for the context and use case of the document type, such as blood pressure, heart rate, respiratory rate, height, weight, body mass index, head circumference, pulse oximetry, temperature, and body surface area. The section should include notable vital signs such as the most recent, maximum and/or minimum, baseline, or relevant trends. Vital signs are represented in the same way as other results, but are aggregated into their own section to follow clinical conventions. |
Wound Characteristic | hl7.cda.us.ccda#current | R5 | This template represents characteristics of a wound (e.g., integrity of suture line, odor, erythema). |
Wound Measurement Observation | hl7.cda.us.ccda#current | R5 | This template represents the Wound Measurement Observations of wound width, depth and length. |
Produced 08 Sep 2023