| ClinicalDocument UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
"A CDA document is comprised of a header and a body. The header identifies and classifies the document; provides information on authentication, the encounter, the patient, and the provider; and sets the context for the document as a whole. The body contains the clinical report, and is conceptually divided up into nested sections, each containing a narrative block to be rendered along with structured entries and external references." - HL7 CDA, ClinicalDocument"A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.)." - HL7 FHIR, Composition
Attributes | ||
AdministrativeClosureAct | administrativeClosure | |
AmendmentAct | amendment | |
PractitionerParticipation | attester |
"A participant who has attested to the accuracy of the composition/document." HL7 FHIR, Composition.attester |
Attribution | authenticator |
"Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it." - HL7 CDA, ClinicalDocument.authenticator |
PractitionerParticipation | author |
"Represents the humans and/or machines that authored the document." HL7 CDA, ClinicalDocument.author"Identifies who is responsible for the information in the composition, not necessarily who typed it in." HL7 FHIR, Composition.author |
«CS» Code | category |
"A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type." HL7 FHIR, Composition.category |
«CS» Code | confidentiality |
"Confidentiality is a required contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value" HL7 CDA, ClinicalDocument.ConfidentialityCode"The code specifying the level of confidentiality of the Composition." HL7 FHIR, Composition.confidentiality |
Organization | custodian |
"Represents the organization that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian." - HL7 CDA, ClinicalDocument.custodian"Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information." HL7 FHIR, Composition.custodian |
Attribution | dataEnterer |
"Represents the participant who has transformed a dictated note into text." - HL7 CDA, ClinicalDocument.dataEnterer |
«TS» PointInTime | date |
"Signifies the document creation time, when the document first came into being. Where the CDA document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created. The time when the transform occurred is not currently represented in CDA." HL7 CDA, ClinicalDocument.effectiveTime"The composition editing time, when the composition was last logically changed by the author." HL7 FHIR, Composition.date |
«EntryPoint» EncounterEvent | encounter |
"This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note." HL7 CDA, ClinicalDocument.EncompassingEncounter"Describes the clinical encounter or type of care this documentation is associated with." HL7 FHIR, Composition.encounter |
EventSummary | event |
"The clinical service, such as a colonoscopy or an appendectomy, being documented." - HL7 FHIR, Composition.event |
«II» Id | identifier |
"Represents the unique instance identifier of a clinical document." HL7 CDA, ClinicalDocument.id"A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time." HL7 FHIR, Composition.identifier |
Image | image |
Pointer to an image that might be associated with the document. |
Attribution | informant |
"An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma." - HL7 CDA, ClinicalDocument.informant |
Attribution | informationRecipient |
"Represents a recipient who should receive a copy of the document." - HL7 CDA, ClinicalDocument.informationRecipient |
«CS» Code | kind |
"The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note). The value set is drawn from LOINC, and has a CWE coding strength." HL7 CDA, ClinicalDocument.code"Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition." HL7 FHIR, Composition.typeNote that LOINC document titles are widely used for this property, and is highly encouraged. |
«CS» Code | language |
"Specifies the human language of character data (whether they be in contents or attribute values). The values of the attribute are language identifiers as defined by the IETF RFC 3066. Language is a contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value." - HL7 CDA, ClinicalDocument.languageCode |
Attribution | legalAuthenticator |
"Represents a participant who has legally authenticated the document." - HL7 CDA, ClinicalDocument.legalAuthenticator |
Attribution | performer |
"A performer is an entity in the role of assigned entity (AssignedEntity class). An assigned entity is a person assigned to the role by the scoping organization" - HL7 CDA, ClinicalDocument.performer |
Patient | recordTarget |
"The recordTarget represents the medical record that this document belongs to. A clinical document typically has exactly one recordTarget participant. In the uncommon case where a clinical document (such as a group encounter note) is placed into more than one patient chart, more than one recordTarget participants can be stated." HL7 CDA, ClinicalDocument.recordTarget"Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure)." HL7 FHIR, Composition.subjectNote that in FHIR, the subject can be entities other than a Patient. In the FHIM (and in CDA), the subject (aka record target) is limited to the Patient to whom the medical record belongs. |
RelatedDocument | relatedDocument |
Pointer to other Clinical Documents to which this Clinical Document is somehow associated."Relationships that this composition has with other compositions or documents that already exist." - HL7 FHIR, Composition.relatesTo |
Attribution | responsibleParty |
"A responsibleParty is a person or organization in the role of an assigned entity (AssignedEntity class). An assigned entity is a person assigned to the role by the scoping organization." - HL7 CDA, ClinicalDocument.responsibleParty |
NullifyAct | retraction |
Records the retraction, or "nullification" of a clinical document. |
ClinicalDocumentSection | section |
Pointer to a set of sections that make up the document."Document sections can nest, can override context propagated from the header..., and can contain narrative and CDA entries." HL7 CDA, ClinicalDocument Section"The root of the sections that make up the composition." HL7 FHIR, Composition.section |
«II» Id | setId |
"Represents an identifier that is common across all document revisions." - HL7 CDA, ClinicalDocument.setId |
«CS» Code | status |
"The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document." HL7 FHIR, Composition.status |
String | title |
"Represents the title of the document. It's commonly the case that clinical documents do not have a title, and are collectively referred to by the display name of ClinicalDocument.code (e.g. a consultation or progress note). Where these display names are rendered to the clinician, or where the document has a unique title, the ClinicalDocument.title component should be used." HL7 CDA, ClinicalDocument.title"Official human-readable label for the composition." HL7 FHIR, Composition.title |
Integer | version |
"An integer value used to version successive replacement documents" - HL7 CDA, ClinicalDocument.versionNumberNote that in FHIR, the version number is handled by the meta tags, so it is not an explicit property. |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | ClinicalDocument |
Name Expression | |
Namespace | ClinicalDocument |
Owned Template Signature | |
Owner | ClinicalDocument |
Owning Template Parameter | |
Package | ClinicalDocument |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public AdministrativeClosureAct administrativeClosure
Aggregation | None |
Alias | |
Association | clinicalDocument_administrativeClosure |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | administrativeClosure |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::administrativeClosure |
Stereotype | |
Template Parameter | |
Type | AdministrativeClosureAct |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public AmendmentAct amendment
Aggregation | None |
Alias | |
Association | clinicalDocument_amendment |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | amendment |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::amendment |
Stereotype | |
Template Parameter | |
Type | AmendmentAct |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PractitionerParticipation attester
"A participant who has attested to the accuracy of the composition/document." HL7 FHIR, Composition.attester
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | attester |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::attester |
Stereotype | |
Template Parameter | |
Type | PractitionerParticipation |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Attribution authenticator
"Represents a participant who has attested to the accuracy of the document, but who does not have privileges to legally authenticate the document. An example would be a resident physician who sees a patient and dictates a note, then later signs it." - HL7 CDA, ClinicalDocument.authenticator
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | authenticator |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::authenticator |
Stereotype | |
Template Parameter | |
Type | Attribution |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PractitionerParticipation author
"Represents the humans and/or machines that authored the document." HL7 CDA, ClinicalDocument.author"Identifies who is responsible for the information in the composition, not necessarily who typed it in." HL7 FHIR, Composition.author
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1..* |
Name | author |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::author |
Stereotype | |
Template Parameter | |
Type | PractitionerParticipation |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code category
"A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type." HL7 FHIR, Composition.category
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | category |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::category |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code confidentiality
"Confidentiality is a required contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value" HL7 CDA, ClinicalDocument.ConfidentialityCode"The code specifying the level of confidentiality of the Composition." HL7 FHIR, Composition.confidentiality
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | confidentiality |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::confidentiality |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Organization custodian
"Represents the organization that is in charge of maintaining the document. The custodian is the steward that is entrusted with the care of the document. Every CDA document has exactly one custodian." - HL7 CDA, ClinicalDocument.custodian"Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information." HL7 FHIR, Composition.custodian
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | custodian |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::custodian |
Stereotype | |
Template Parameter | |
Type | Organization |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Attribution dataEnterer
"Represents the participant who has transformed a dictated note into text." - HL7 CDA, ClinicalDocument.dataEnterer
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | dataEnterer |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::dataEnterer |
Stereotype | |
Template Parameter | |
Type | Attribution |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime date
"Signifies the document creation time, when the document first came into being. Where the CDA document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created. The time when the transform occurred is not currently represented in CDA." HL7 CDA, ClinicalDocument.effectiveTime"The composition editing time, when the composition was last logically changed by the author." HL7 FHIR, Composition.date
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | date |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::date |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «EntryPoint» EncounterEvent encounter
"This optional class represents the setting of the clinical encounter during which the documented act(s) or ServiceEvent occurred. Documents are not necessarily generated during an encounter, such as when a clinician, in response to an abnormal lab result, attempts to contact the patient but can't, and writes a Progress Note." HL7 CDA, ClinicalDocument.EncompassingEncounter"Describes the clinical encounter or type of care this documentation is associated with." HL7 FHIR, Composition.encounter
Aggregation | None |
Alias | |
Association | clinicalDocument_encounter |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | encounter |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::encounter |
Stereotype | |
Template Parameter | |
Type | «EntryPoint» EncounterEvent |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public EventSummary event
"The clinical service, such as a colonoscopy or an appendectomy, being documented." - HL7 FHIR, Composition.event
Aggregation | None |
Alias | |
Association | clinicalDocument_event |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | event |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::event |
Stereotype | |
Template Parameter | |
Type | EventSummary |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «II» Id identifier
"Represents the unique instance identifier of a clinical document." HL7 CDA, ClinicalDocument.id"A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time." HL7 FHIR, Composition.identifier
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | identifier |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Image image
Pointer to an image that might be associated with the document.
Aggregation | None |
Alias | |
Association | clinicalDocument_image |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | image |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::image |
Stereotype | |
Template Parameter | |
Type | Image |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Attribution informant
"An informant (or source of information) is a person that provides relevant information, such as the parent of a comatose patient who describes the patient's behavior prior to the onset of coma." - HL7 CDA, ClinicalDocument.informant
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | informant |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::informant |
Stereotype | |
Template Parameter | |
Type | Attribution |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Attribution informationRecipient
"Represents a recipient who should receive a copy of the document." - HL7 CDA, ClinicalDocument.informationRecipient
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | informationRecipient |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::informationRecipient |
Stereotype | |
Template Parameter | |
Type | Attribution |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code kind
"The code specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note). The value set is drawn from LOINC, and has a CWE coding strength." HL7 CDA, ClinicalDocument.code"Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition." HL7 FHIR, Composition.typeNote that LOINC document titles are widely used for this property, and is highly encouraged.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | kind |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::kind |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code language
"Specifies the human language of character data (whether they be in contents or attribute values). The values of the attribute are language identifiers as defined by the IETF RFC 3066. Language is a contextual component of CDA, where the value expressed in the header holds true for the entire document, unless overridden by a nested value." - HL7 CDA, ClinicalDocument.languageCode
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | language |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::language |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Attribution legalAuthenticator
"Represents a participant who has legally authenticated the document." - HL7 CDA, ClinicalDocument.legalAuthenticator
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | legalAuthenticator |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::legalAuthenticator |
Stereotype | |
Template Parameter | |
Type | Attribution |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Attribution performer
"A performer is an entity in the role of assigned entity (AssignedEntity class). An assigned entity is a person assigned to the role by the scoping organization" - HL7 CDA, ClinicalDocument.performer
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | performer |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::performer |
Stereotype | |
Template Parameter | |
Type | Attribution |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Patient recordTarget
"The recordTarget represents the medical record that this document belongs to. A clinical document typically has exactly one recordTarget participant. In the uncommon case where a clinical document (such as a group encounter note) is placed into more than one patient chart, more than one recordTarget participants can be stated." HL7 CDA, ClinicalDocument.recordTarget"Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure)." HL7 FHIR, Composition.subjectNote that in FHIR, the subject can be entities other than a Patient. In the FHIM (and in CDA), the subject (aka record target) is limited to the Patient to whom the medical record belongs.
Aggregation | None |
Alias | |
Association | clinicalDocument_recordTarget |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | recordTarget |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::recordTarget |
Stereotype | |
Template Parameter | |
Type | Patient |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public RelatedDocument relatedDocument
Pointer to other Clinical Documents to which this Clinical Document is somehow associated."Relationships that this composition has with other compositions or documents that already exist." - HL7 FHIR, Composition.relatesTo
Aggregation | None |
Alias | |
Association | clinicalDocument_relatedDocument |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | relatedDocument |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::relatedDocument |
Stereotype | |
Template Parameter | |
Type | RelatedDocument |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Attribution responsibleParty
"A responsibleParty is a person or organization in the role of an assigned entity (AssignedEntity class). An assigned entity is a person assigned to the role by the scoping organization." - HL7 CDA, ClinicalDocument.responsibleParty
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | responsibleParty |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::responsibleParty |
Stereotype | |
Template Parameter | |
Type | Attribution |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public NullifyAct retraction
Records the retraction, or "nullification" of a clinical document.
Aggregation | None |
Alias | |
Association | clinicalDocument_retraction |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | retraction |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::retraction |
Stereotype | |
Template Parameter | |
Type | NullifyAct |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public ClinicalDocumentSection section
Pointer to a set of sections that make up the document."Document sections can nest, can override context propagated from the header..., and can contain narrative and CDA entries." HL7 CDA, ClinicalDocument Section"The root of the sections that make up the composition." HL7 FHIR, Composition.section
Aggregation | None |
Alias | |
Association | clinicalDocument_section |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | false |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | section |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::section |
Stereotype | |
Template Parameter | |
Type | ClinicalDocumentSection |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «II» Id setId
"Represents an identifier that is common across all document revisions." - HL7 CDA, ClinicalDocument.setId
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | setId |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::setId |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code status
"The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document." HL7 FHIR, Composition.status
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | status |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::status |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String title
"Represents the title of the document. It's commonly the case that clinical documents do not have a title, and are collectively referred to by the display name of ClinicalDocument.code (e.g. a consultation or progress note). Where these display names are rendered to the clinician, or where the document has a unique title, the ClinicalDocument.title component should be used." HL7 CDA, ClinicalDocument.title"Official human-readable label for the composition." HL7 FHIR, Composition.title
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | title |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::title |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Integer version
"An integer value used to version successive replacement documents" - HL7 CDA, ClinicalDocument.versionNumberNote that in FHIR, the version number is handled by the meta tags, so it is not an explicit property.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ClinicalDocument |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | version |
Name Expression | |
Namespace | ClinicalDocument |
Opposite | |
Owner | ClinicalDocument |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::ClinicalDocument::ClinicalDocument::version |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| ClinicalDocument UML Documentation |
Summary:AttributesProperties | Detail:Attributes |