Cardea
cardea.fhir.
DocumentReference
A reference to a document.
resourceType – This is a DocumentReference resource
masterIdentifier – Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
identifier – Other identifiers associated with the document, including version independent identifiers.
status – The status of this document reference.
docStatus – The status of the underlying document.
type – Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
class – A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
subject – Who or what the document is about. The document 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 farm animals, or a set of patients that share a common exposure).
created – When the document was created.
indexed – When the document reference was created.
author – Identifies who is responsible for adding the information to the document.
authenticator – Which person or organization authenticates that this document is valid.
custodian – Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
relatesTo – Relationships that this document has with other document references that already exist.
description – Human-readable description of the source document. This is sometimes known as the “title”.
securityLabel – A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the “reference” to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
content – The document and format referenced. There may be multiple content element repetitions, each with a different format.
context – The clinical context in which the document was prepared.
__init__
Initialize self. See help(type(self)) for accurate signature.
Methods
__init__([dict_values])
Initialize self.
assert_type()
assert_type
Checks class values follow set possible enumerations.
get_dataframe()
get_dataframe
Returns dataframe from class attribute values.
get_eligible_relationships()
get_eligible_relationships
Returns class relationships for attributes that are used.
get_id()
get_id
Returns fhir class identifier.
get_relationships()
get_relationships
Returns class relationships.
set_attributes(dict_values)
set_attributes
Sets values to class attributes.