| ACTIVE_IND |
NUMBER |
N |
The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc. |
| ACTIVE_STATUS_CD |
NUMBER |
N |
Indicates the status of the row itself (not the data in the row) such as active, inactive, combined away, pending purge, etc. |
| ACTIVE_STATUS_DT_TM |
DATE |
N |
The date and time that the active_status_cd was set. |
| ACTIVE_STATUS_PRSNL_ID |
NUMBER |
N |
The person who caused the active_status_cd to be set or change. |
| AVAILABILITY_STATUS |
VC2(40) |
N |
an XDS Document shall have one of two availability statuses: Approved - available for patient care; Deprecated - obsolete |
| BEG_EFFECTIVE_DT_TM |
DATE |
N |
The date and time for which this table row becomes effective. Normally, this will be the date and time the row is added, but could be a past or future date and time. |
| CLASS_CD |
NUMBER |
N |
Specifies the particular kind of document (e.g. Prescription, Discharge Summary, Report). |
| CLASS_CODE_DISPLAY_NAME |
VC2(256) |
Y |
The name to be displayed for communicating to a human the meaning of the classCode |
| CLASS_CODE_TXT |
VC2(100) |
Y |
The literal value from the message of the class code associated with the document metadata. |
| COMMENTS_ID |
NUMBER |
N |
Free form text comments associated with the Document. The comments will be written on the long_text table. |
| CONTENT_TYPE |
VC2(255) |
Y |
The content type of the document as it is stored in CAMM |
| CONTRIBUTOR_SYSTEM_CD |
NUMBER |
N |
Contributor system identifies the source feed of data from which a row was populated. This is mainly used to determine how to update a set of data that may have originated from more than one source feed. |
| CREATION_DT_TM |
DATE |
Y |
Date and Time the author created the document in the source system |
| DOC_ACTION_STATUS_CD |
NUMBER |
N |
Status of the document in terms of the relationship with the database. Values include New or Processed. |
| DOC_EVENT_ID |
NUMBER |
N |
The Event ID of the child document that this record is related to. - this value is from EVENT_ID in CLINICAL_EVENT. |
| DOC_FORMAT_CD |
NUMBER |
N |
Allows a potential consumer to know how to render the specific media file format of the document and corresponds to the equivalent MIME type of the document as it was stored in CAMM. |
| DOC_QUERIED_DT_TM |
DATE |
N |
The date that the Document was queried. |
| DOC_RETR_ACK_SI_MESSAGE_LOG_ID |
NUMBER |
N |
Foreign key to the SI_MESSAGE_LOG table for the audited transport protocol message containing the acknowledgement after it is received inbound. |
| DOC_RETR_COMPLETE_DT_TM |
DATE |
N |
The date and time of when the retrieve of the related document finished. |
| DOC_RETR_ERR_CODE |
VC2(40) |
Y |
A textual error code that represents an error in retrieval if any has occurred. |
| DOC_RETR_ERR_TEXT |
VC2(255) |
Y |
The error text that was returned to the system if any errors had occurred during the retrieval. |
| DOC_RETR_QUEUE_ID |
NUMBER |
N |
Foreign key to the CQM_OENINTERFACE_QUE table for an enqueued retrieval request. |
| DOC_RETR_SI_MESSAGE_LOG_ID |
NUMBER |
N |
Foreign key to the SI_MESSAGE_LOG table for the audited transport protocol message containing a retrieval request after it is sent outbound. |
| DOC_RETR_START_DT_TM |
DATE |
N |
The date and time of when the retrieve of the related document started. |
| DOC_RETR_STATUS_CD |
NUMBER |
N |
Retrieval status of the document. Values include Queried, Completed, Retrieved, Parsed, Purged, Direct, and various Failures. (code set 4002660) |
| DOC_TITLE |
VC2(255) |
Y |
Title of the document |
| DOC_VALID_IND |
NUMBER |
N |
Indicates whether the retrieved document has been successfully validated against the XDOC_HASH, XDOC_SIZE (when available) and/or successfully passed an XML well-formedness check, or any other methods of validation relevant to the document type. |
| END_EFFECTIVE_DT_TM |
DATE |
N |
The date/time after which the row is no longer valid as active current data. This may be valued with the date that the row became inactive. |
| FORMAT_CD |
NUMBER |
N |
Along with typeCode, should provide sufficient information to allow potential consumer to know if it will be able to process the document. Shall be sufficiently specific to ensure processing/display by identifying a document encoding, structure and template (e.g. for HITSP CCD, the fact that it complies with a CDA schema, a template, and choice of content-specific style sheet. |
| FORMAT_CODE_TXT |
VC2(100) |
Y |
The literal value from the message of the format code associated with the document metadata. |
| FORMAT_DISPLAY_NAME |
VC2(256) |
Y |
Raw text from the message related to the Format Code |
| HEALTHCARE_FACILITY_TYPE_CD |
NUMBER |
N |
Represents the type of organizational setting of the clinical encounter during which the documented act occurred. Alias From: HCFACTYPCODE |
| HEALTHCARE_FAC_TYPE_DISP_NAME |
VC2(256) |
Y |
Raw text from the message related to the healthcare facility type code. |
| HEALTHCARE_FAC_TYPE_TXT |
VC2(100) |
Y |
The literal value from the message of the healthcare facility type associated with the document metadata. |
| HOME_COMMUNITY_IDENT |
VC2(100) |
Y |
The Community shared by the creator of the document and the registry that the document was sent to. |
| INSTANCE_IND |
NUMBER |
N |
Indicates whether the record is a document instance. |
| LANGUAGE_CD |
NUMBER |
N |
Human language of character data in the document. As identified by the IETF RFC 3066. Code Set 36 |
| LAST_INSTANCE_XDOC_METADATA_ID |
NUMBER |
N |
Foreign key to the SI_XDOC_METADATA record that identifies the last successfully retrieved document instance |
| LEGAL_AUTH_NAME_FIRST |
VC2(100) |
Y |
First name of the person who signed as the legal authenticator. |
| LEGAL_AUTH_NAME_FULL_FRMT |
VC2(255) |
Y |
Represents a participant who has legally authenticated the document within the authorInstitution. |
| LEGAL_AUTH_NAME_LAST |
VC2(100) |
Y |
Last name of the person who signed as the legal authenticator. |
| LEGAL_AUTH_NAME_MIDDLE |
VC2(100) |
Y |
Middle name of the person who signed as the legal authenticator. |
| LEGAL_AUTH_NAME_PREFIX |
VC2(50) |
Y |
Prefix of the person who signed as the legal authenticator. |
| LEGAL_AUTH_NAME_SUFFIX |
VC2(50) |
Y |
Suffix of the person who signed as the legal authenticator. |
| MDOC_EVENT_ID |
NUMBER |
N |
The Event ID of the Parent document that this record is related to.this value is from EVENT_ID in CLINICAL_EVENT. |
| MEDIA_OBJECT_IDENTIFIER |
VC2(64) |
Y |
Identifier of the document object if stored in the multimedia storage. |
| MEDIA_OBJECT_VERSION_NBR |
NUMBER |
Y |
Version of the identified document object in the multimedia storage. |
| MIME_TYPE |
VC2(40) |
Y |
MIME type of the document in the Repository |
| NEW_REPOSITORY_UNIQUE_IDENT |
VC2(100) |
Y |
An optional new repository unique id that identifies the repository where the document instance was stored after generation. |
| NEW_SOURCE_DOC_UNIQUE_IDENT |
VC2(100) |
Y |
A new source document unique id that identifies a new document instance. |
| OBJECT_TYPE_DISPLAY |
VC2(60) |
Y |
The human-readable representation of the corresponding object_type_txt column for this record. |
| OBJECT_TYPE_TEXT |
VC2(60) |
Y |
Describes the type of document received in terms of: on-demand, delayed generation, initial generation |
| PARENT_DOCUMENT_IDENT |
VC2(100) |
Y |
The identifier of the parentDocument entry that represents the source of a document replacement, addendum, transformation, or signs relationship |
| PARENT_DOCUMENT_RELTN |
VC2(100) |
Y |
Type of relationship that the document has with the parentDocument: Replace, addendum, transformation, or signs |
| PARENT_DOC_EVENT_ID |
NUMBER |
N |
The parent event ID that will be passed down from the parent document in terms of appends and replacement documents. |
| PARENT_MDOC_EVENT_ID |
NUMBER |
N |
The parent MDOC to be carried through the life cycle of the series of events created by document generation |
| PARENT_SI_XDOC_METADATA_ID |
NUMBER |
N |
The related document metadata record. |
| PERSON_ID |
NUMBER |
N |
The person related to the queried document. |
| PRACTICE_SETTING_CD |
NUMBER |
N |
Specifies the clinical specialty where the act that resulted in the document was performed. Alias From: PRACSETCODE |
| PRACTICE_SETTING_DISPLAY_NAME |
VC2(256) |
Y |
Raw text from the message related to the Practice Setting Code. |
| PRACTICE_SETTING_TXT |
VC2(100) |
Y |
The literal value from the message of the practice setting associated with the document metadata. |
| REPOSITORY_UNIQUE_IDENT |
VC2(100) |
N |
An OID that is used to uniquely define the repository |
| REPO_DOCUMENT_UNIQUE_IDENT |
VC2(100) |
N |
The Identifier known by the registry and repository to uniquely indentify the related document. |
| SERVICE_START_DT_TM |
DATE |
N |
Represents the start time the service being documented took place (clinically significant). |
| SERVICE_STOP_DT_TM |
DATE |
N |
Represents the stop time the service being documented took place (clinically significant) |
| SI_XDOC_METADATA_ID |
NUMBER |
N |
The primary key to the document metadata table. |
| SI_XDOC_QUERY_PERSON_RELTN_ID |
NUMBER |
N |
Foreign key to query relationship to track which query was responsible for this document. |
| SOURCE_DOC_UNIQUE_IDENT |
VC2(100) |
Y |
Globally unique identifier assigned by the document creator to this document. May be used in the body of other XDS Documents to reference this document. Structure and format shall be consistent with the specification corresponding to the format attribute (e.g., DICOM 64 character numeric UID, HL7 CDA root^extension |
| SOURCE_PATIENT_IDENT |
VC2(255) |
Y |
Represents the subject of care medical record identifier in the local MPI. It shall contain 2 parts: Authority Domain Id and an Id in the above domain. |
| TRANSPORT_METHOD |
VC2(20) |
Y |
The transport used to retrieve the document. |
| TYPE_CD |
NUMBER |
N |
Specifies the precise kind of document (e.g. Pulmonary History and Physical, Discharge Summary, Ultrasound Report). |
| TYPE_CODE_DISPLAY_NAME |
VC2(256) |
Y |
Raw Text from the message related to the Type Code. |
| TYPE_CODE_TXT |
VC2(100) |
Y |
The literal value from the message of the type code associated with the document metadata. |
| UPDT_APPLCTX |
NUMBER |
N |
The application context number from the record info block. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_CNT |
NUMBER |
N |
Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_DT_TM |
DATE |
N |
The date and time the row was last inserted or updated. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_ID |
NUMBER |
N |
The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_TASK |
NUMBER |
N |
The registered (assigned) task number for the process that inserted or updated the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| XDOC_HASH |
VC2(256) |
Y |
Hash key of the XDS Document itself. |
| XDOC_SIZE |
NUMBER |
N |
Size in bytes of the byte stream that was provided in the Register and Provide Transaction and stored by the XDS Document Repository. |
