Package org.projecthusky.common.model
Class Author
java.lang.Object
org.projecthusky.common.model.Author
Author
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionAuthor()
Instantiates a new author.Author
(boolean nullFlavored) Creates a null flavored author according to ELGA spec (necessary for PHARM DIS)Author
(POCDMT000040Author authorMdht) Erstellt ein husky-Author Objekt mittels eines MDHT-Author Objekts.Author
(POCDMT000040AuthoringDevice device) Instantiates a new software author (e.g.Author
(AuthoringDevice device) Instantiates a new software author (e.g.Instantiates a new author.Instantiates a new human author.Instantiates a new author.Author
(Organization organizationAsAuthor) Creates a new Author based on the given Organization objectCreates a new Author based on the given Patient objectInstantiates a new human author.Instantiates a new author. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAddress
(Address address) Weist dem Autor eine Postadresse zu.void
addId
(Identificator identificator) Weist dem Autoren eine ID zu.void
Adds the name.Gets the address.Gets the addresses.Method to getGets the author.Gets the complete name.Gets the functionCode of the authorgetGln()
Gets the gln (identification of the author)Gets the gln as identificator.getIds()
Gets all ids of the authorgetName()
Gets the (first) family name.getNames()
Gets the names.Gets the organization (RepresentedOrganization).Method to getGets the author function code.Sets the author speciality code.Gets the telecoms.Gets the author time.@Nullable Hl7Dtm
Returns the participation start time as anHl7Dtm
ornull
.@Nullable Instant
Returns the participation start time as anHl7Dtm
ornull
.boolean
Checks if is author patient.void
setAsAuthor
(POCDMT000040AssignedAuthor asAuthor) Method to setvoid
void
setAuthor
(POCDMT000040Author author) Method to setvoid
setFunctionCode
(Code code) Sets the functionCode of the authorvoid
Indicates that the author is the patient itself.void
Sets the gln.void
setOrganization
(Organization organization) Sets the organization (RepresentedOrganization).void
setOtherFunctionCode
(String codeSystem, String codeSystemName, String originalText) Sets the other function code.void
setPerson
(POCDMT000040Person person) Method to setvoid
setRoleFunction
(Code code) Sets the author function code.void
setSpeciality
(Code code) Sets the author speciality code.void
setTelecoms
(List<Telecom> telecoms) Sets the telecoms.void
Sets the author time.
-
Field Details
-
FUNCTION_CODE_AUTHOR_PATIENT
-
FUNCTION_CODE_AUTHORDEVICE
-
-
Constructor Details
-
Author
public Author()Instantiates a new author. -
Author
Instantiates a new software author (e.g. a laboratory information system)- Parameters:
device
- the device
-
Author
Instantiates a new software author (e.g. a laboratory information system)- Parameters:
device
- the device
-
Author
public Author(boolean nullFlavored) Creates a null flavored author according to ELGA spec (necessary for PHARM DIS)- Parameters:
nullFlavored
- True
-
Author
Instantiates a new author. -
Author
Instantiates a new human author.- Parameters:
name
- the name
-
Author
Instantiates a new author.- Parameters:
name
- Namegln
- Global Location Number (GLN)
-
Author
Erstellt ein husky-Author Objekt mittels eines MDHT-Author Objekts.- Parameters:
authorMdht
- the MDHT Author Object
-
Author
Creates a new Author based on the given Organization object- Parameters:
organizationAsAuthor
- this Organization is used as Author
-
Author
Creates a new Author based on the given Patient object- Parameters:
patientAsAuthor
- this Patient is used as Author
-
Author
Instantiates a new human author.- Parameters:
person
- the person
-
Author
Instantiates a new author.- Parameters:
person
- the persongln
- Global Location Number (GLN)
-
-
Method Details
-
addAddress
Weist dem Autor eine Postadresse zu.- Parameters:
address
- Die Postadresse des Autors
-
addId
Weist dem Autoren eine ID zu.- Parameters:
identificator
- Kombination von eigentlicher ID und der OID der verwaltenden Domäne
-
addName
Adds the name.- Parameters:
name
- name
-
getAddress
Gets the address.- Returns:
- the address
-
getAddresses
Gets the addresses.- Returns:
- the addresses
-
getAsAuthor
Method to get- Returns:
- the asAuthor
-
setAsAuthor
Method to set- Parameters:
asAuthor
- the asAuthor to set
-
getAuthorMdht
Gets the author.- Returns:
- the author
-
getCompleteName
Gets the complete name.- Returns:
- the complete name
-
getFunctionCode
Gets the functionCode of the author- Returns:
- the functionCode. Null, if not present.
-
setFunctionCode
Sets the functionCode of the author- Parameters:
code
- the functionCode
-
getGln
Gets the gln (identification of the author)- Returns:
- the gln
-
setGln
Sets the gln.- Parameters:
gln
- the new gln. If null an Id with nullFlavor = NA will be added.
-
getGlnAsIdentificator
Gets the gln as identificator.- Returns:
- the gln as identificator
-
getIds
Gets all ids of the author- Returns:
- the ids
-
getMdhtTelecoms
-
getName
Gets the (first) family name.- Returns:
- the name
-
getNames
Gets the names.- Returns:
- the names
-
getOrganization
Gets the organization (RepresentedOrganization). This element can also be used as author represented organization, when a document is beeing sent (via XDS, XDM, XDR).- Returns:
- organization the organization
-
setOrganization
Sets the organization (RepresentedOrganization). The code can also be used as author role, when a document is being sent (via XDS, XDM, XDR).- Parameters:
organization
- the new organization
-
getPerson
Method to get- Returns:
- the person
-
setPerson
Method to set- Parameters:
person
- the person to set
-
getRoleFunction
Gets the author function code. This element specifies in which role or function the author is related to this document (e.g. Code "40001" for "Apotheker"). The code can also be used as author role, when a document is beeing sent (via XDS, XDM, XDR).- Returns:
- code the function code
-
setRoleFunction
Sets the author function code. This element specifies in which role or function the author is related to this document (e.g. Code "40001" for "Apotheker"). The code can also be used as author role, when a document is beeing sent (via XDS, XDM, XDR).- Parameters:
code
- the function code
-
getSpeciality
Sets the author speciality code. This element specifies the speciality ("Fachrichtung", e.g. "Fachärztin/Facharzt für Allgemeine Innere Medizin" ) of the author. The code can also be used as author speciality, when a document is beeing sent (via XDS, XDM, XDR).- Returns:
- code the speciality code
-
setSpeciality
Sets the author speciality code. This element specifies the speciality ("Fachrichtung", e.g. Code "50001" for "Fachärztin/Facharzt für Allgemeine Innere Medizin") of the author. The code can also be used as author speciality, when a document is beeing sent (via XDS, XDM, XDR).- Parameters:
code
- the speciality code
-
getTelecoms
Gets the telecoms.- Returns:
- Telecoms the telecoms
-
setTelecoms
Sets the telecoms.- Parameters:
telecoms
- the new telecoms
-
getTimeAsDate
Gets the author time. The author/time element represents the start time of the author’s participation in the creation of the clinical document- Returns:
- date the start time of the participation as string
-
getTimeAsHl7Dtm
Returns the participation start time as anHl7Dtm
ornull
. -
getTimeAsInstant
Returns the participation start time as anHl7Dtm
ornull
. -
isAuthorPatient
public boolean isAuthorPatient()Checks if is author patient.- Returns:
- true, if is author patient
-
setAssignedAuthoringDevice
-
setAuthor
Method to set- Parameters:
author
- the author to set
-
setFunctionCodePatient
public void setFunctionCodePatient()Indicates that the author is the patient itself. -
setOtherFunctionCode
Sets the other function code.- Parameters:
codeSystem
- the code system OID.codeSystemName
- the name of the code system.originalText
- the original text (narrative text of the code).
-
setTime
Sets the author time. The author/time element represents the start time of the author’s participation in the creation of the clinical document.- Parameters:
date
- the start time of the participation as date
-