au.gov.nehta.model.clinical.shs

Interface SharedHealthSummaryAuthor

All Known Implementing Classes:

SharedHealthSummaryAuthorImpl

public interface SharedHealthSummaryAuthor

Document author for a shared health summary.

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
ZonedDateTime	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.

Method Detail

getRole

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 publicly available MAY be used.

getParticipationPeriod

ZonedDateTime 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.

getEntityIdentifiers

List<AsEntityIdentifier> getEntityIdentifiers()

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

getAddresses

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.

getElectronicCommunicationDetails

List<Telecom> getElectronicCommunicationDetails()

The electronic communication details of entities.

getPersonNames

List<PersonName> getPersonNames()

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

getEmploymentDetail

ExtendedEmploymentOrganisation getEmploymentDetail()

getEntitlements

List<? extends Entitlement> getEntitlements()

getID

String getID()

author/assignedAuthor/id

A 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.