au.gov.nehta.model.clinical.shs

Class SharedHealthSummaryAuthorImpl

java.lang.Object

au.gov.nehta.model.clinical.shs.SharedHealthSummaryAuthorImpl

All Implemented Interfaces:

SharedHealthSummaryAuthor

public class SharedHealthSummaryAuthorImpl
extends Object
implements SharedHealthSummaryAuthor

Document author for a shared health summary

Constructor Summary

Constructors

Constructor and Description
SharedHealthSummaryAuthorImpl(Coded role, org.joda.time.DateTime participationPeriod, List<AsEntityIdentifier> entityIdentifiers, List<AddressContext> addresses, List<Telecom> electronicCommunicationDetails, List<PersonName> personNames, ExtendedEmploymentOrganisation employmentDetail) Creates an author section with the optional participation period
SharedHealthSummaryAuthorImpl(Coded role, List<AsEntityIdentifier> entityIdentifiers, List<PersonName> personNames, ExtendedEmploymentOrganisation employmentDetail) Creates an author section without the optional participation period

Method Summary

Modifier and Type	Method and Description
List<AddressContext>	getAddresses() The description of a location where an entity is located or can be otherwise reached or found and a description of the purpose for which that address is primarily used by that entity.
List<Telecom>	getElectronicCommunicationDetails() The electronic communication details of entities.
ExtendedEmploymentOrganisation	getEmploymentDetail()
List<? extends Entitlement>	getEntitlements()
List<AsEntityIdentifier>	getEntityIdentifiers() A number or code issued for the purpose of identifying a participant within a healthcare context.
String	getID() author/assignedAuthor/id THIS WILL BE A RANDOM UUID UNLESS EXPLICITLY SET UUID.
org.joda.time.DateTime	getParticipationPeriod() This element will hold the same value as Shared Health Summary > Date- Time Attested (ClinicalDocument/ legalAuthenticator/ time) Although the definition of this element states that it is a time interval, the following applies: "The end of the participation period of a Document Author participation is the time associated with the completion of editing the content of a document.".
List<PersonName>	getPersonNames() The appellation by which an individual may be identified separately from any other within a social context.
Coded	getRole() The involvement or role of the participant in the related action from a healthcare perspective rather than the specific participation perspective.
void	setEntitlements(List<? extends Entitlement> entitlements)
void	setID(String id) author/assignedAuthor/id Overrides the default value, which is a random UUID this is a required CDA element, a technical identifier that is used for system purposes such as matching.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SharedHealthSummaryAuthorImpl

public SharedHealthSummaryAuthorImpl(Coded role,
                                     List<AsEntityIdentifier> entityIdentifiers,
                                     List<PersonName> personNames,
                                     ExtendedEmploymentOrganisation employmentDetail)

Creates an author section without the optional participation period

SharedHealthSummaryAuthorImpl

public SharedHealthSummaryAuthorImpl(Coded role,
                                     org.joda.time.DateTime participationPeriod,
                                     List<AsEntityIdentifier> entityIdentifiers,
                                     List<AddressContext> addresses,
                                     List<Telecom> electronicCommunicationDetails,
                                     List<PersonName> personNames,
                                     ExtendedEmploymentOrganisation employmentDetail)

Creates an author section with the optional participation period

Method Detail

getRole

public Coded getRole()

The involvement or role of the participant in the related action from a healthcare perspective rather than the specific participation perspective. Role SHOULD have a value chosen from 1220.0 - ANZSCO - Australian and New Zealand Standard Classification of Occupations, First Edition, 2006 - METeOR 350899. [ABS2006]. However, if a suitable value in this set cannot be found, then any code set that is both registered with HL7 and publically available MAY be used.

Specified by:

getRole in interface SharedHealthSummaryAuthor

getParticipationPeriod

public org.joda.time.DateTime getParticipationPeriod()

This element will hold the same value as Shared Health Summary > Date- Time Attested (ClinicalDocument/ legalAuthenticator/ time) Although the definition of this element states that it is a time interval, the following applies: "The end of the participation period of a Document Author participation is the time associated with the completion of editing the content of a document.". Thus only the end time need be recorded.

Specified by:

getParticipationPeriod in interface SharedHealthSummaryAuthor

getEntityIdentifiers

public List<AsEntityIdentifier> getEntityIdentifiers()

A number or code issued for the purpose of identifying a participant within a healthcare context.

Specified by:

getEntityIdentifiers in interface SharedHealthSummaryAuthor

getAddresses

public List<AddressContext> getAddresses()

The description of a location where an entity is located or can be otherwise reached or found and a description of the purpose for which that address is primarily used by that entity.

Specified by:

getAddresses in interface SharedHealthSummaryAuthor

getElectronicCommunicationDetails

public List<Telecom> getElectronicCommunicationDetails()

The electronic communication details of entities.

Specified by:

getElectronicCommunicationDetails in interface SharedHealthSummaryAuthor

getPersonNames

public List<PersonName> getPersonNames()

The appellation by which an individual may be identified separately from any other within a social context.

Specified by:

getPersonNames in interface SharedHealthSummaryAuthor

getEmploymentDetail

public ExtendedEmploymentOrganisation getEmploymentDetail()

Specified by:

getEmploymentDetail in interface SharedHealthSummaryAuthor

getEntitlements

public List<? extends Entitlement> getEntitlements()

Specified by:

getEntitlements in interface SharedHealthSummaryAuthor

setEntitlements

public void setEntitlements(List<? extends Entitlement> entitlements)

getID

public String getID()

author/assignedAuthor/id THIS WILL BE A RANDOM UUID UNLESS EXPLICITLY SET UUID. Required CDA element. This is a technical identifier that is used for system purposes such as matching. If a suitable internal key is not available, a UUID MAY be used.

Specified by:

getID in interface SharedHealthSummaryAuthor

setID

public void setID(String id)

author/assignedAuthor/id Overrides the default value, which is a random UUID this is a required CDA element, a technical identifier that is used for system purposes such as matching. If a suitable internal key is not available, a UUID MAY be used.