public abstract class ActFactory extends Object
Act
objects.
The behavior of this factory varies depending on whether or not a
ServiceLocator is supplied.
If a ServiceLocator is supplied, then the factories will assign an 'internal
identifier' with the root specified by
OIDService.getOID(OIDService.INTERNAL_ROOT)
and a sequence
generated extension text to every RIM object created with a
newX
method below.
If no ServiceLocator is supplied, then allocation of the internal identifier
is deferred until RimService.submit()
. In this case no round
trips
will every be performed by this class. Act.Code
. Therefore, while it is possible for a user to
instantiate an Act instance containing an Act.Code
with
qualifiers, RimServices will ignore all qualifiers provided on the
Act.Code
attribute, and will only validate and store the root
concept. No error message or exception will be provided to indicate the
presence of qualifiers on this attribute. Constructor and Description |
---|
ActFactory() |
Modifier and Type | Method and Description |
---|---|
static ActFactory |
getInstance()
Used by services to create an
Instance of the
ActFactory . |
abstract Act |
makeReference(ReferenceModifier modifier,
CS actClass,
CS moodCode,
CD code,
SET<II> id,
int versionNumber)
Creates a reference to an object that is assumed to already exist in HDR.
|
abstract Act |
newAccession(CS moodCode,
CD code,
SET<II> id)
ACSN (accession) A unit of work, a grouper of work items as defined by
the system performing that work.
|
abstract Act |
newAccommodation(CS moodCode,
CD code,
SET<II> id)
ACCM (accommodation) An accommodation is a service provided for a Person
or other LivingSubject in which a place is provided for the subject to
reside for a period of time.
|
abstract Account |
newAccount(CS moodCode,
CD code,
SET<II> id)
ACCT (account) A financial account established to track the net result of
financial acts.
|
abstract Act |
newAcquisitionExposure(CS moodCode,
CD code,
SET<II> id)
AEXPOS (acquisition exposure) An acquisition exposure act describes the
proximity (location and time) through which the participating entity was
potentially exposed to a physical (including energy), chemical or
biological agent from another entity.
|
abstract Act |
newAct(CS actClass,
CS moodCode,
CD code,
SET<II> id)
Used by applications where the class is passed in rather than determined
Programmatically.
|
abstract ControlAct |
newAction(CS moodCode,
CD code,
SET<II> id)
ACTN (action) Sender asks addressee to do something depending on the
focal
Act of the payload. |
abstract Act |
newAdjudication(CS moodCode,
CD code,
SET<II> id)
ADJUD (financial adjudication) A transformation process where a requested
invoice is transformed into an agreed invoice.
|
abstract Observation |
newBattery(CS moodCode,
CD code,
SET<II> id)
BATTERY (battery) A battery specifies a set of observations.
|
abstract Observation |
newBioSequence(CS moodCode,
CD code,
SET<II> id)
SEQ (bio sequence) A sequence of biomolecule like the DNA, RNA, protein
and the like.
|
abstract Observation |
newBioSequenceVariation(CS moodCode,
CD code,
SET<II> id)
SEQVAR (bio sequence variation) A variation in a sequence as described by
BioSequence.
|
abstract Observation |
newBoundedROI(CS moodCode,
CD code,
SET<II> id)
ROIBND (bounded ROI) A Region of Interest (ROI) specified for a
multidimensional observation, such as an Observation Series (OBSSER).
|
abstract Act |
newCategory(CS moodCode,
CD code,
SET<II> id)
CATEGORY (category) A group of entries within a composition or topic that
have a common characteristic - for example, Examination, Diagnosis,
Management OR Subjective, Objective, Analysis, Plan.
|
abstract Document |
newCDAL1Document(CS moodCode,
CD code,
SET<II> id)
CDALVLONE A clinical document that conforms to Level One of the HL7
Clinical Document Architecture (CDA).
|
abstract Document |
newClinicalDocument(CS moodCode,
CD code,
SET<II> id)
DOCCLIN (clinical document) A clinical document is a documentation of
clinical observations and services, with the following characteristics:
|
abstract Observation |
newClinicalTrial(CS moodCode,
CD code,
SET<II> id)
CLNTRL (clinical trial) The set of actions that define an experiment to
assess the effectiveness and/or safety of a biopharmaceutical product
(food, drug, device, etc.).
|
abstract Act |
newClinicalTrialTimepointEvent(CS moodCode,
CD code,
SET<II> id)
CTTEVENT (clinical trial timepoint event) An identified point during a
clinical trial at which one or more actions are scheduled to be performed
(definition mood), or are actually performed (event mood).
|
abstract Act |
newCluster(CS moodCode,
CD code,
SET<II> id)
CLUSTER (cluster) A group of entries within a composition, topic or
category that have a logical association with one another.
|
abstract Act |
newComposition(CS moodCode,
CD code,
SET<II> id)
COMPOSITION (composition) A context representing a grouped commitment of
information to the EHR.
|
abstract Act |
newConcern(CS moodCode,
CD code,
SET<II> id)
CONC (concern) A worry that tends to persist over time and has as its
subject a state or process.
|
abstract Observation |
newCondition(CS moodCode,
CD code,
SET<II> id)
COND (condition) An observable finding or state that persists over time
and tends to require intervention or management, and, therefore,
distinguished from an observation made at a point in time; may exist
before an Observation of the condition is made or after interventions to
manage the condition are undertaken.
|
abstract Observation |
newConditionNode(CS moodCode,
CD code,
SET<II> id)
CNOD (condition Node) An instance of
Observation of a
Condition at a point in time that includes any
Observation or Procedure associated with that
Condition as well as links to previous instances of the
condition node for the same Condition . |
abstract Act |
newConsent(CS moodCode,
CD code,
SET<II> id)
CONS (consent) The
Consent class represents informed
consents and all similar medico-legal transactions between the patient
(or his legal guardian) and the provider. |
abstract Act |
newContainer(CS moodCode,
CD code,
SET<II> id)
CONTAINER (record container) Container of clinical statements.
|
abstract DeviceTask |
newContainerRegistration(CS moodCode,
CD code,
SET<II> id)
CONTREG (container registration) An
Act where a container is
registered either via an automated sensor, such as a barcode reader, or
by manual receipt. |
abstract Act |
newContract(CS moodCode,
CD code,
SET<II> id)
CNTRCT (contract) An agreement of obligation between two or more parties
that is subject to contractual law and enforcement.
|
abstract ControlAct |
newControlActEvent(CD triggerEvent,
SET<II> id)
CACT (control act) Create an act representing a system action such as the
change of state of another act or the initiation of a query.
|
abstract Observation |
newCorrelatedObservationSequences(CS moodCode,
CD code,
SET<II> id)
OBSCOR (correlated observation sequences) Container for Observation
Sequences (Observations whose values are contained in LIST<>'s) having
values correlated with each other.
|
abstract FinancialContract |
newCoverage(CS moodCode,
CD code,
SET<II> id)
COV (coverage) A healthcare insurance policy or plan that is
contractually binding between two or more parties.
|
abstract Observation |
newDetectedIssue(CS moodCode,
CD code,
SET<II> id)
ALRT (detected issue) An observation identifying a potential adverse
outcome as a result of an
Act or combination of acts. |
abstract Observation |
newDeterminantPeptide(CS moodCode,
CD code,
SET<II> id)
DETPOL (determinant peptide) A determinant peptide in a polypeptide as
described by polypeptide.
|
abstract DiagnosticImage |
newDiagnosticImage(CS moodCode,
CD code,
SET<II> id)
DGIMG (diagnostic image) Class for holding attributes unique to
diagnostic images.
|
abstract Diet |
newDiet(CS moodCode,
CD code,
SET<II> id)
DIET (diet) Diet services are supply services, with some aspects
resembling Medication services: the detail of the diet is given as a
description of the Material associated via
Participation.typeCode="product".
|
abstract Act |
newDisciplinaryAction(CS moodCode,
CD code,
SET<II> id)
DISPACT (Disciplinary Action) An action taken with respect to a subject
Entity by a regulatory or authoritative body with supervisory capacity
over that entity.
|
abstract Document |
newDocument(CS moodCode,
CD code,
SET<II> id)
DOC (document) The notion of a document comes particularly from the paper
world, where it corresponds to the contents recorded on discrete pieces
of paper.
|
abstract Act |
newDocumentBody(CS moodCode,
CD code,
SET<II> id)
DOCBODY (document body) A context that distinguishes the body of a
document from the document header.
|
abstract Act |
newDocumentSection(CS moodCode,
CD code,
SET<II> id)
DOCSECT (document section) A context that subdivides the body of a
document.
|
abstract Act |
newElectronicHealthRecord(CS moodCode,
CD code,
SET<II> id)
EHR (electronic health record) A context that comprises all compositions.
|
abstract Act |
newEntry(CS moodCode,
CD code,
SET<II> id)
ENTRY (entry) This context represents the information acquired and
recorded for an observation, a clinical statement such as a portion of
the patient's history or an inference or assertion, or an action that
might be intended or has actually been performed.
|
abstract Act |
newExposure(CS moodCode,
CD code,
SET<II> id)
EXPOS (exposure) An interaction between entities that provides opportunity
for transmission of a physical, chemical, or biological agent from an
exposure source entity to an exposure target entity.
|
abstract Observation |
newExpressionLevel(CS moodCode,
CD code,
SET<II> id)
EXP (expression level) An expression level of genes/proteins or other
expressed genomic entities.
|
abstract Act |
newExtract(CS moodCode,
CD code,
SET<II> id)
EXTRACT (extract) This context represents the part of a patient record
conveyed in a single communication.
|
abstract FinancialContract |
newFinancialContract(CS moodCode,
CD code,
SET<II> id)
FCNTRCT (financial contract) A contract whose value is measured in
monetary terms.
|
abstract FinancialTransaction |
newFinancialTransaction(CS moodCode,
CD code,
SET<II> id)
XACT (financial transaction) A sub-class of
Act representing
any transaction between ' two accounts whose value is measured in
monetary terms. |
abstract Act |
newFolder(CS moodCode,
CD code,
SET<II> id)
FOLDER (folder) A context representing the high-level organization of an
extract e.g.
|
abstract Observation |
newGenomicObservation(CS moodCode,
CD code,
SET<II> id)
GEN (genomic observation) An observation of genomic phenomena.
|
abstract Act |
newGrouper(CS moodCode,
CD code,
SET<II> id)
GROUPER (grouper) An ACT that organizes a set of component acts into a
semantic grouping that share a particular context such as timeframe,
patient, etc.
|
abstract Act |
newIncident(CS moodCode,
CD code,
SET<II> id)
INC (incident) An event that occurred outside of the control of one or
more of the parties involved.
|
abstract Act |
newInform(CS moodCode,
CD code,
SET<II> id)
INFRM (inform) The act of transmitting information and understanding
about a topic to a subject.
|
abstract ControlAct |
newInformation(CS moodCode,
CD code,
SET<II> id)
INFO (information) Sender sends payload to addressee as information.
|
abstract Observation |
newInvestigation(CS moodCode,
CD code,
SET<II> id)
INVSTG (investigation) An official inquiry into the circumstances
surrounding a particular unplanned event or potential event for the
purposes of identifying possible causes and contributing factors for the
event.
|
abstract InvoiceElement |
newInvoiceElement(CS moodCode,
CD code,
SET<II> id)
INVE (invoice element) Represents concepts related to invoice processing
in healthcare.
|
abstract Act |
newJurisdictionalPolicy(CS moodCode,
CD code,
SET<II> id)
JURISPOL (jurisdictional policy) A mandate, regulation, obligation,
requirement, rule,
or expectation unilaterally imposed by a jurisdiction on (a)The activity
of another party
(b)The behavior of another party (c)The manner in which an act is
executed.
|
abstract Observation |
newLocus(CS moodCode,
CD code,
SET<II> id)
LOC (locus) The position of a gene (or other significant sequence) on the
genome.
|
abstract Observation |
newMonitoringProgram(CS moodCode,
CD code,
SET<II> id)
MPROT (monitoring program) An officially or unofficially instituted
program to track acts of a particular type or categorization.
|
abstract Observation |
newObservation(CS moodCode,
CD code,
SET<II> id)
OBS (observation) Observations are actions performed in order to
determine an answer or result value.
|
abstract Observation |
newObservationSeries(CS moodCode,
CD code,
SET<II> id)
OBSSER (observation series) Container for Correlated Observation
Sequences sharing a common frame of reference.
|
abstract Act |
newOrganizationalPolicy(CS moodCode,
CD code,
SET<II> id)
ORGPOL (organizational policy) A mandate, obligation, requirement,
rule, or expectation unilaterally imposed by an organization on (a)The
activity of another party
(b)The behavior of another party (c)The manner in which an act is
executed.
|
abstract Act |
newOrganizer(CS moodCode,
CD code,
SET<II> id)
ORGANIZER (organizer) Organizer of entries.
|
abstract PublicHealthCase |
newOutbreak(CS moodCode,
CD code,
SET<II> id)
OUTB (outbreak) An outbreak represents a series of public health cases.
|
abstract Act |
newOutbreakV3(CS moodCode,
CD code,
SET<II> id)
OUTBR (outbreak) An Outbreak is a concern resulting from a series of
public
health cases.
|
abstract Observation |
newOverlayROI(CS moodCode,
CD code,
SET<II> id)
ROIOVL (overlay ROI) A Region of Interest (ROI) specified for an image
using an overlay shape.
|
abstract Act |
newPatientCareProvision(CS moodCode,
CD code,
SET<II> id)
PCPR (patient care provision) A patient care provision is the taking on
of the responsibility by a performer for the health care of a patient or
group of patients.
|
abstract PatientEncounter |
newPatientEncounter(CS moodCode,
CD code,
SET<II> id)
ENC (encounter) An interaction between a patient and healthcare
participant(s) for the purpose of providing patient service(s) or
assessing the health status of a patient.
|
abstract Observation |
newPhenotype(CS moodCode,
CD code,
SET<II> id)
PHN (phenotype) A genomic phenomenon that is expressed externally in the
organism.
|
abstract Act |
newPolicy(CS moodCode,
CD code,
SET<II> id)
POLICY (policy) :A mandate, regulation, obligation, requirement, rule, or
expectation unilaterally
imposed by one party on (a)The activity of another party (b)The behavior
of another party
(c)The manner in which an act is executed.
|
abstract Observation |
newPolypeptide(CS moodCode,
CD code,
SET<II> id)
POL (polypeptide) A polypeptide resulting from the translation of a gene.
|
abstract Observation |
newPosition(CS moodCode,
CD code,
SET<II> id)
POS (Position) An observation representing the physical location of a
place based on a reference coordinate system.
|
abstract Observation |
newPositionAccuracy(CS moodCode,
CD code,
SET<II> id)
POSACC (PositionAccuracy) An observation representing the degree to which
the assignment of the spatial coordinates, based on a matching algorithm
by a geocoding engine against a reference spatial database, matches true
or accepted values.
|
abstract Observation |
newPositionCoordinate(CS moodCode,
CD code,
SET<II> id)
POSCOORD (PositionCoordinate) An observation representing one of a set of
numerical values used to determine the position of a place.
|
abstract Procedure |
newProcedure(CS moodCode,
CD code,
SET<II> id)
PROC (procedure) An Act whose immediate and primary outcome
(post-condition) is the alteration of the physical condition of the
subject.
|
abstract PublicHealthCase |
newPublicHealthCase(CS moodCode,
CD code,
SET<II> id)
CASE (public health case) A public health case is an
Observation representing a condition or event that has a
specific significance for public health. |
abstract Act |
newPublicHealthCaseV3(CS moodCode,
CD code,
SET<II> id)
POSCOORD (PositionCoordinate) An observation representing one of a set of
numerical values used to determine the position of a place.
|
abstract QueryAct |
newQueryAct(CoreFetch fetch)
Creates a
QueryAct . |
abstract Act |
newRegistryAct(CS moodCode,
CD code,
SET<II> id)
REG (registration) Represents the act of maintaining information about an
entity or role in a registry.
|
abstract Act |
newReview(CS moodCode,
CD code,
SET<II> id)
REV (Review) The act of examining and evaluating the subject, usually
another act.
|
abstract Act |
newScopeOfPracticePolicy(CS moodCode,
CD code,
SET<II> id)
SCOPOL (scope of practice policy) An ethical or clinical obligation,
requirement, rule, or expectation imposed or strongly encouraged by
organizations that oversee particular clinical domains or provider
certification which define the boundaries within which a provider may
practice and which may have legal basis or ramifications on (a)The
activity of another party (b)The behavior of another party (c)The manner
in which an act is executed.
|
abstract Procedure |
newSpecimenCollection(CS moodCode,
CD code,
SET<II> id)
SPECCOLLECT (Specimen Collection) A procedure for obtaining a specimen
from a source entity.
|
abstract Observation |
newSpecimenObservation(CS moodCode,
CD code,
SET<II> id)
SPCOBS (specimen observation) An observation on a specimen in a
laboratory environment that may affect processing, analysis or result
interpretation.
|
abstract Act |
newSpecimenTreatment(CS moodCode,
CD code,
SET<II> id)
SPCTRT (specimen treatment) A procedure or treatment performed on a
specimen to prepare it for analysis.
|
abstract Act |
newStandardOfPracticePolicy(CS moodCode,
CD code,
SET<II> id)
STDPOL (standard of practice policy) A requirement, rule, or expectation
typically documented as guidelines, protocols, or formularies imposed or
strongly encouraged by an organization that oversees or has authority over
the practices within a domain, and which may have legal basis or
ramifications on (a)The activity of another party (b)The behavior of
another \
party (c)The manner in which an act is executed.
|
abstract ControlAct |
newStateTransitionControl(CS moodCode,
CD code,
SET<II> id)
STC (state transition control) Sender transmits a status change
pertaining to the focal act of the payload.
|
abstract Act |
newStorage(CS moodCode,
CD code,
SET<II> id)
STORE (Storage) The act of putting something away for safe keeping.
|
abstract SubstanceAdministration |
newSubstanceAdministration(CS moodCode,
CD code,
SET<II> id)
SBADM (substance administration) The act of introducing or otherwise
applying a substance to the subject.
|
abstract Procedure |
newSubstanceExtraction(CS moodCode,
CD code,
SET<II> id)
SBEXT (Substance Extraction) The act of removing a substance from the
subject.
|
abstract Act |
newSubstitution(CS moodCode,
CD code,
SET<II> id)
SUBST (Substitution) Definition: Indicates that the subject Act has
undergone or should undergo substitution of a type indicated by Act.code.
|
abstract Supply |
newSupply(CS moodCode,
CD code,
SET<II> id)
SPLY (supply) Supply orders and deliveries are simple acts that focus on
the delivered product.
|
abstract Act |
newTopic(CS moodCode,
CD code,
SET<II> id)
TOPIC (topic) A group of entries within a composition that are related to
a common clinical theme - such as a specific disorder or problem,
prevention, screening and provision of contraceptive services.
|
abstract Act |
newTransfer(CS moodCode,
CD code,
SET<II> id)
TRFR (transfer) The act of transferring information without the intent of
imparting understanding about a topic to the subject that is the recipient
or holder of the transferred information where the participation
association must be RCV or HLD.
|
abstract Act |
newTransmissionExposure(CS moodCode,
CD code,
SET<II> id)
TEXPOS (transmission exposure) A transmission exposure act describes the
proximity (time and location) over which the participating source entity
was capable of transmitting a physical (including energy), chemical or
biological
substance agent to another entity.
|
abstract Act |
newTransportation(CS moodCode,
CD code,
SET<II> id)
TRNS (transportation) Transportation is the moving of a payload (people
or material) from a location of origin to a destination location.
|
abstract Observation |
newVerification(CS moodCode,
CD code,
SET<II> id)
VERIF (Verification) An act which describes the process whereby a
'verifying party' validates either the existence of a Role and its
associated classes, or of an Act and its participations.
|
abstract WorkingList |
newWorkingList(CS moodCode,
CD code,
SET<II> id)
LIST (working list) Working list collects a dynamic list of individual
instances of Act via ActRelationship which reflects the need of an
individual worker, team of workers, or an organization to manage lists of
acts for many different clinical and administrative reasons.
|
public static ActFactory getInstance()
Instance
of the
ActFactory
.ActFactory
object.public abstract Act newAct(CS actClass, CS moodCode, CD code, SET<II> id) throws HDRRimException
actClass
- ActClass
Class code for the
Act
. This parameter is mandatory.moodCode
- ActMood
Mood code for the
Act
. This is a mandatory parameter.code
- Code for the Act
. This is an optional parameter.id
- Identification of the act, may be null
, however,
HDR will always generate an internal identifier for the act.
The II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.HDRRimException
- when the actClass or the moodCode is passed as
null
.public abstract ControlAct newControlActEvent(CD triggerEvent, SET<II> id) throws HDRRimException
CACT (control act) Create an act representing a system action such as the
change of state of another act or the initiation of a query. All control
acts represent trigger events in the HL7 context. ControlAct
may occur in different moods.
Oracle:
ControlAct
is also known as Database Entry Vehicle
(DBEV) in HDR.CSActMood.EVN
.Once created, payload acts can be added to the control act using the
addActRelationship( "SUBJ", ...)
method.
triggerEvent
- Trigger event code, may be null
.id
- Identification of the control act, may be
null
. However, HDR will always
generate an internal identifier for the act. The II is unique
across a broad class (Act, Entity, non-owned Role) rather than
across the finer grained classes of HL7.ControlAct
created.HDRRimException
ActClass.CACT
,
ActMood.EVN
public abstract Act newRegistryAct(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
registry Act
. This is a mandatory parameter.code
- Code for the registry Act
. This is an optional
parameter.id
- Identification of the registry Act
, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.REG
public abstract PatientEncounter newPatientEncounter(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
PatientEncounter
. This is a mandatory parameter.code
- Code for the PatientEncounter
. This is an
optional parameter.id
- Identification of the PatientEncounter
, may be
null
. However, HDR will always
generate an internal identifier. The II is unique across a
broad class (Act, Entity, non-owned Role) rather than across
the finer grained classes of HL7.HDRRimException
- when the mood code is passed as null
.ActClass.ENC
public abstract Observation newObservation(CS moodCode, CD code, SET<II> id) throws HDRRimException
OBS (observation) Observations are actions performed in order to determine an answer or result value. Observation result values (Observation.value) include specific information about the observed object. The type and constraints of result values depend on the kind of action performed.
Clinical documents commonly have 'Subjective' and 'Objective' findings, both of which are kinds of observations. In addition, clinical documents commonly contain 'Assessments', which are also kinds of Observations. Thus, the establishment of a diagnosis is an Observation.
moodCode
- ActMood
Mood code for the
Observation
. This is a mandatory parameter.code
- Code for the Observation
. This is an optional
parameter.id
- identification of the Observation
, may be
null
, however, HDR will always
generate an internal identifier. The II is unique across a
broad class (Act, Entity, non-owned Role) rather than across
the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.OBS
public abstract Act newComposition(CS moodCode, CD code, SET<II> id) throws HDRRimException
COMPOSITION (composition) A context representing a grouped commitment of information to the EHR. It is considered the unit of modification of the record, the unit of transmission in record extracts, and the unit of attestation by authorizing clinicians.
A composition represents part of a patient record originating from a single interaction between an authenticator and the record.
Unless otherwise stated all statements within a composition have the same authenticator, apply to the same patient and were recorded in a single session of use of a single application.
A composition contains organizers and entries.
moodCode
- ActMood
Mood code for the
composition. This is a mandatory parameter.code
- Code for the composition. This is an optional parameter.id
- identification of the composition, may be
null
, however, HDR will always
generate an internal identifier. The II is unique across a
broad class (Act, Entity, non-owned Role) rather than across
the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.COMPOSITION
public abstract Document newDocument(CS moodCode, CD code, SET<II> id) throws HDRRimException
DOC (document) The notion of a document comes particularly from the paper world, where it corresponds to the contents recorded on discrete pieces of paper. In the electronic world, a document is a kind of composition that bears resemblance to their paper world counter-parts. Documents typically are meant to be human-readable.
HL7's notion of document differs from that described in the W3C XML Recommendation, in which a document refers specifically to the contents that fall between the root element's start-tag and end-tag. Not all XML documents are HL7 documents.
moodCode
- ActMood
Mood code for the
Document
. This is a mandatory parameter.code
- Code for the Document
. This is an optional
parameter.id
- Identification of the Document
, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.DOC
public abstract SubstanceAdministration newSubstanceAdministration(CS moodCode, CD code, SET<II> id) throws HDRRimException
SBADM (substance administration) The act of introducing or otherwise applying a substance to the subject.
Discussion: The effect of the substance is typically established on a biochemical basis, however, that is not a requirement. For example, radiotherapy can largely be described in the same way, especially if it is a systemic therapy such as radio-iodine. This class also includes the application of chemical treatments to an area.
Examples: Chemotherapy protocol; Drug prescription; Vaccination record
moodCode
- ActMood
Mood code for the
SubstanceAdministration
. This is a mandatory
parameter.code
- Code for the SubstanceAdministration
. This is an
optional parameter.id
- Identification of the SubstanceAdministration, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.SubstanceAdministration
Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.SBADM
public abstract Document newClinicalDocument(CS moodCode, CD code, SET<II> id) throws HDRRimException
DOCCLIN (clinical document) A clinical document is a documentation of clinical observations and services, with the following characteristics:
moodCode
- ActMood
Mood code for the
clinical Document
. This is a mandatory parameter.code
- Code for the clinical Document
. This is an
optional parameter.id
- identification of the clinical Document
, may be
null
, however, HDR will always
generate an internal identifier. The II is unique across a
broad class (Act, Entity, non-owned Role) rather than across
the finer grained classes of HL7.Document
Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.DOCCLIN
public abstract Document newCDAL1Document(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
CDAL1 Document
. This is a mandatory parameter.code
- Code for the CDAL1 Document
. This is an optional
parameter.id
- Identification of the CDAL1 Document
, may be
null
, however, HDR will always
generate an internal identifier. The II is unique across a
broad class (Act, Entity, non-owned Role) rather than across
the finer grained classes of HL7.Document
Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.CDALVLONE
public abstract Act newEntry(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
entry. This is a mandatory parameter.code
- Code for the entry. This is an optional parameter.id
- Identification of the entry, may be null
, however, HDR will always generate an internal
identifier. The II is unique across a broad class (Act,
Entity, non-owned Role) rather than across the finer grained
classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.ENTRY
public abstract Observation newBattery(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
battery. This is a mandatory parameter.code
- Code for the battery. This is an optional parameter.id
- Identification of the battery, may be null
, however, HDR will always generate an internal
identifier. The II is unique across a broad class (Act,
Entity, non-owned Role) rather than across the finer grained
classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.BATTERY
public abstract Act newCluster(CS moodCode, CD code, SET<II> id) throws HDRRimException
CLUSTER (cluster) A group of entries within a composition, topic or category that have a logical association with one another.
The representation of a single observation or action might itself be
multi-part. The data might need to be represented as a nested set of
values, as a table, list, or as a time series. The Cluster
class permits such aggregation within an entry for such compound data.
Examples include "Haematology investigations" which might include two or more distinct batteries.
A cluster may contain batteries and/or individual entries
moodCode
- ActMood
Mood code for the
cluster. This is a mandatory parameter.code
- Code for the cluster. This is an optional parameter.id
- identification of the cluster, may be null
, however, HDR will always generate an internal
identifier. The II is unique across a broad class (Act,
Entity, non-owned Role) rather than across the finer grained
classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.CLUSTER
public abstract Act newExtract(CS moodCode, CD code, SET<II> id) throws HDRRimException
EXTRACT (extract) This context represents the part of a patient record conveyed in a single communication. It is drawn from a providing system for the purposes of communication to a requesting process (which might be another repository, a client application or a middleware service such as an electronic guideline engine), and supporting the faithful inclusion of the communicated data in the receiving system.
An extract may be the entirety of the patient record as held by the sender or it may be a part of that record (e.g. changes since a specified date).
An extract contains folders or compositions.
An extract cannot contain another extract.
moodCode
- ActMood
Mood code for the
extract. This is a mandatory parameter.code
- Code for the extract. This is an optional parameter.id
- identification of the extract, may be null
, however, HDR will always generate an internal
identifier. The II is unique across a broad class (Act,
Entity, non-owned Role) rather than across the finer grained
classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.EXTRACT
public abstract Act newElectronicHealthRecord(CS moodCode, CD code, SET<II> id) throws HDRRimException
EHR (electronic health record) A context that comprises all compositions. The EHR is an extract that includes the entire chart.
NOTE: In an exchange scenario, an EHR is a specialization of an extract.
moodCode
- ActMood
Mood code for the
electronic health record. This is a mandatory parameter.code
- Code for the electronic health record. This is an optional
parameter.id
- identification of the electronic health record, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.ElectronicHealthRecord
Act
created.HDRRimException
- when the moodCode is passed as null
.ActClass.EHR
public abstract Act newFolder(CS moodCode, CD code, SET<II> id) throws HDRRimException
FOLDER (folder) A context representing the high-level organization of an extract e.g. to group parts of the record by episode, care team, clinical specialty, clinical condition, or source application. Internationally, this kind of organizing structure is used variably: in some centers and systems the folder is treated as an informal compartmentalization of the overall health record; in others it might represent a significant legal portion of the EHR relating to the originating enterprise or team.
A folder contains compositions.
Folders may be nested within folders.
moodCode
- ActMood
Mood code for the
folder. This is a mandatory parameter.code
- Code for the folder. This is an optional parameter.id
- Identification of the folder, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.FOLDER
public abstract Act newOrganizer(CS moodCode, CD code, SET<II> id) throws HDRRimException
ORGANIZER (organizer) Organizer of entries. Navigational. No semantic content. Knowledge of the section code is not required to interpret contained observations. Represents a heading in a heading structure, or "organizer tree".
The record entries relating to a single clinical session are usually grouped under headings that represent phases of the encounter, or assist with layout and navigation. Clinical headings usually reflect the clinical workflow during a care session, and might also reflect the main author's reasoning processes. Much research has demonstrated that headings are used differently by different professional groups and specialties, and that headings are not used consistently enough to support safe automatic processing of the E H R.
moodCode
- ActMood
Mood code for the
organizer. This is a mandatory parameter.code
- Code for the organizer. This is an optional parameter.id
- identification of the organizer, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.ORGANIZER
public abstract Act newCategory(CS moodCode, CD code, SET<II> id) throws HDRRimException
CATEGORY (category) A group of entries within a composition or topic that have a common characteristic - for example, Examination, Diagnosis, Management OR Subjective, Objective, Analysis, Plan.
The distinction from Topic relates to value sets. For Category there is a bounded list of things like "Examination", "Diagnosis" or SOAP categories. For Topic the list is wide open to any clinical condition or reason for a part of an encounter.
A CATEGORY MAY CONTAIN ENTRIES.
moodCode
- ActMood
Mood code for the
category. This is a mandatory parameter.code
- Code for the category. This is an optional parameter.id
- identification of the category, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.CATEGORY
public abstract Act newDocumentBody(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
document body. This is a mandatory parameter.code
- Code for the document body. This is an optional parameter.id
- Identification of the document body, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood cde is passed as null
.ActClass.DOCBODY
public abstract Act newDocumentSection(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
document section. This is a mandatory parameter.code
- Code for the document section. This is an optional parameter.id
- Identification of the document section, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the moodCode is passed as null
.ActClass.DOCSECT
public abstract Act newTopic(CS moodCode, CD code, SET<II> id) throws HDRRimException
TOPIC (topic) A group of entries within a composition that are related to a common clinical theme - such as a specific disorder or problem, prevention, screening and provision of contraceptive services.
A topic may contain categories and entries.
moodCode
- ActMood
Mood code for the
topic. This is a mandatory parameter.code
- Code for the topic. This is an optional parameter.id
- Identification of the topic, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.TOPIC
public abstract Act newAccommodation(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
accommodation. This is a mandatory parameter.code
- Code for the accommodation. This is an optional parameter.id
- Identification of the accommodation, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.ACCM
public abstract Account newAccount(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
account. This is a mandatory parameter.code
- Code for the account. This is an optional parameter.id
- identification of the account, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the moodCode is passed as null
.ActClass.ACCT
public abstract Act newAccession(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
accession. This is a mandatory parameter.code
- Code for the accession. This is an optional parameter.id
- identification of the accession, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.ACSN
public abstract Act newAdjudication(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
adjudication. This is a mandatory parameter.code
- Code for the adjudication. This is an optional parameter.id
- Identification of the adjudication, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.ADJUD
public abstract ControlAct newAction(CS moodCode, CD code, SET<II> id) throws HDRRimException
Act
of the payload. An example is
"fulfill this order". Addressee has responsibilities to either reject the
message or to act on it in an appropriate way (specified by the specific
receiver responsibilities for the interaction).moodCode
- ActMood
Mood code for the
action. This is a mandatory parameter.code
- Code for the action. This is an optional parameter.id
- Identification of the action, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.ACTN
public abstract ControlAct newInformation(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
information. This is a mandatory parameter.code
- Code for the information. This is an optional parameter.id
- identification of the information, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.INFO
public abstract ControlAct newStateTransitionControl(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
state transition control. This is a mandatory parameter.code
- Code for the state transition control. This is an optional
parameter.id
- identification of the state transition control, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.STC
public abstract Act newContract(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
contract. This is a mandatory parameter.code
- Code for the contract. This is an optional parameter.id
- Identification of the contract, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.CNTRCT
public abstract FinancialContract newFinancialContract(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
financial contract. This is a mandatory parameter.code
- Code for the financial contract. This is an optional
parameter.id
- Identification of the financial contract, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the moodCode is passed as null
.ActClass.FCNTRCT
public abstract FinancialContract newCoverage(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
coverage. This is a mandatory parameter.code
- Code for the coverage. This is an optional parameter.id
- identification of the coverage, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the moodCode is passed as null
.ActClass.COV
public abstract Act newConsent(CS moodCode, CD code, SET<II> id) throws HDRRimException
CONS (consent) The Consent
class represents informed
consents and all similar medico-legal transactions between the patient
(or his legal guardian) and the provider. Examples are: informed consent
for surgical procedures, informed consent for clinical trials, advanced
beneficiary notice, against medical advice decline from service, release
of information agreement, etc.
The details of consents vary. Often an institution has a number of
different consent forms for various purposes, including reminding the
physician about the topics to mention. Such forms also include patient
education material. In electronic medical record communication, consents
thus are information-generating acts on their own and need to be managed
similar to medical activities. Thus, Consent
is modeled as a
special class of Act
.
The "signatures" to the consent document are represented electronically
through Participation
instances to the consent object.
Typically an informed consent has Participation.typeCode
of
"performer", the healthcare provider informing the patient, and
"consenter", the patient or legal guardian. Some consent may associate a
witness or a notary public abstract (e.g., living wills, advanced
directives). In consents where a healthcare provider is not required
(e.g. living will), the performer may be the patient himself or a notary
public.
Some consent has a minimum required delay between the consent and the
service, so as to allow the patient to rethink his decisions. This
minimum delay can be expressed in the act definition by the
ActRelationship.pauseQuantity
attribute that delays the
service until the pause time has elapsed after the consent has been
completed.
moodCode
- ActMood
Mood code for the
consent. This is a mandatory parameter.code
- Code for the consent. This is an optional parameter.id
- Identification of the consent, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.CONS
public abstract DeviceTask newContainerRegistration(CS moodCode, CD code, SET<II> id) throws HDRRimException
Act
where a container is
registered either via an automated sensor, such as a barcode reader, or
by manual receipt.moodCode
- ActMood
Mood code for the
container registration. This is a mandatory parameter.code
- Code for the container registration. This is an optional
parameter.id
- Identification of the container registration, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.CONTREG
public abstract Act newClinicalTrialTimepointEvent(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
clinical trial timepoint event. This is a mandatory parameter.code
- Code for the clinical trial timepoint event. This is an
optional parameter.id
- Identification of the clinical trial timepoint event, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.CTTEVENT
public abstract Act newIncident(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
incident. This is a mandatory parameter.code
- Code for the incident. This is an optional parameter.id
- Identification of the incident, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the moodCode is passed as null
.ActClass.INC
public abstract Act newInform(CS moodCode, CD code, SET<II> id) throws HDRRimException
INFRM (inform) The act of transmitting information and understanding about a topic to a subject.
Discussion: This act may be used to request that a patient or provider be
informed about an Act
, or to indicate that a person was
informed about a particular act.
moodCode
- ActMood
Mood code for the
inform. This is a mandatory parameter.code
- Code for the inform. This is an optional parameter.id
- identification of the inform, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.INFRM
public abstract InvoiceElement newInvoiceElement(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
invoice element. This is a mandatory parameter.code
- Code for the invoice element. This is an optional parameter.id
- identification of the invoice element, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.INVE
public abstract WorkingList newWorkingList(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
working list. This is a mandatory parameter.code
- Code for the working list. This is an optional parameter.id
- identification of the working list, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the moodCode is passed as null
.ActClass.LIST
public abstract Observation newBoundedROI(CS moodCode, CD code, SET<II> id) throws HDRRimException
ActRelationship
objects of type "has component" (COMP). In each boundary criterion, the
Act.code
names the dimension and the Observation.value
specifies the range of values inside the region. Typically the to be
bounded dimension is continuous, and so the Observation.value will be an
interval (IVL) data type. The Observation.value
need not be
specified if the respective dimension is only named but not constrained.
For example, an ROI for the QT interval of a certain beat in EKG Lead II
would contain 2 boundary criteria, one naming the interval in time
(constrained), and the other naming the interval in ECG Lead II (only
named, but not constrained).moodCode
- ActMood
Mood code for the
bounded ROI. This is a mandatory parameter.code
- Code for the bounded ROI. This is an optional parameter.id
- identification of the bounded ROI, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.ROIBND
public abstract Observation newOverlayROI(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
overlay ROI. This is a mandatory parameter.code
- Code for the overlay ROI. This is an optional parameter.id
- identification of the overlay ROI, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.ROIOVL
public abstract Observation newDetectedIssue(CS moodCode, CD code, SET<II> id) throws HDRRimException
ALRT (detected issue) An observation identifying a potential adverse
outcome as a result of an Act
or combination of acts.
Examples: Detection of a drug-drug interaction; Identification of a late-submission for an invoice; Requesting discharge for a patient who does not meet hospital-defined discharge criteria.
Discussion: This class is commonly used for identifying 'business rule' or 'process' problems that may result in a refusal to carry out a particular request. In some circumstances it may be possible to 'bypass' a problem by modifying the request to acknowledge the issue and/or by providing some form of mitigation.
Constraints: the Act
or acts that may cause the the adverse
outcome are the target of a subject ActRelationship. The subbtypes of
this concept indicate the type of problem being detected (e.g. drug-drug
interaction) while the Observation.value is used to repesent a specific
problem code (e.g. specific drug-drug interaction id).
moodCode
- ActMood
Mood code for the
detected issue. This is a mandatory parameter.code
- Code for the detected issue. This is an optional parameter.id
- identification of the detected issue, may be null
, however, HDR will always generate an internal identifier.
The II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.ALRT
public abstract PublicHealthCase newPublicHealthCase(CS moodCode, CD code, SET<II> id) throws HDRRimException
Observation
representing a condition or event that has a
specific significance for public health. Typically it involves an
instance or instances of a reportable infectious disease or other
condition. The public health case can include a health-related event
concerning a single individual or it may refer to multiple health-related
events that are occurrences of the same disease or condition of interest
to public health. An outbreak involving multiple individuals may be
considered as a type of public health case. A public health case
definition (Act.moodCode
= "definition") includes the
description of the clinical, laboratory, and epidemiologic indicators
associated with a disease or condition of interest to public health.
There are case definitions for conditions that are reportable, as well as
for those that are not. There are also case definitions for outbreaks. A
public health case definition is a construct used by public health for
the purpose of counting cases, and should not be used as clinical
indications for treatment. Examples include AIDS, toxic-shock syndrome,
and salmonellosis and their associated indicators that are used to define
a case.moodCode
- ActMood
Mood code for the
PublicHealthCase
. This is a mandatory parameter.code
- Code for the PublicHealthCase
. This is an
optional parameter.id
- identification of the PublicHealthCase
, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.CASE
public abstract PublicHealthCase newOutbreak(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
outbreak. This is a mandatory parameter.code
- Code for the outbreak. This is an optional parameter.id
- identification of the outbreak, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.OUTB
public abstract Observation newClinicalTrial(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
clinical trial. This is a mandatory parameter.code
- Code for the clinical trial. This is an optional parameter.id
- identification of the clinical trial, may be null
, however, HDR will always generate an internal identifier.
The II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.CLNTRL
public abstract Observation newConditionNode(CS moodCode, CD code, SET<II> id) throws HDRRimException
Observation
of a
Condition
at a point in time that includes any
Observation
or Procedure
associated with that
Condition
as well as links to previous instances of the
condition node for the same Condition
.moodCode
- ActMood
Mood code for the
condition node. This is a mandatory parameter.code
- Code for the condition node. This is an optional parameter.id
- identification of the condition node, may be null
, however, HDR will always generate an internal identifier.
The II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.CNOD
public abstract Observation newCondition(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- Mood code for the condition. This is a mandatory parameter.code
- Code for the condition. This is an optional parameter.id
- identification of the condition, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.COND
public abstract DiagnosticImage newDiagnosticImage(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
diagnostic image. This is a mandatory parameter.code
- Code for the diagnostic image. This is an optional parameter.id
- identification of the diagnostic image, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.DGIMG
public abstract Observation newInvestigation(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
investigation. This is a mandatory parameter.code
- Code for the investigation. This is an optional parameter.id
- identification of the investigation, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.INVSTG
public abstract Observation newMonitoringProgram(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
monitoring program. This is a mandatory parameter.code
- Code for the monitoring program. This is an optional
parameter.id
- identification of the monitoring program, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.MPROT
public abstract Observation newObservationSeries(CS moodCode, CD code, SET<II> id) throws HDRRimException
cd
must be comparable and relative to the common frame
of reference. For example, a 3-channel ECG device records a 12-lead ECG
in 4 steps (3 leads at a time). Each of the separate 3-channel recordings
would be in their own "OBSCOR". And, all 4 OBSCOR would be contained in
one OBSSER because all the times are relative to the same origin
(beginning of the recording) and all the ECG signals were from a fixed
set of electrodes.moodCode
- ActMood
Mood code for the
observation series. This is a mandatory parameter.code
- Code for the observation series. This is an optional
parameter.id
- Identification of the observation series, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.OBSSER
public abstract Observation newCorrelatedObservationSequences(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
correlated observation sequences. This is a mandatory
parameter.code
- Code for the correlated observation sequences. This is an
optional parameter.id
- identification of the correlated observation sequences, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.OBSCOR
public abstract Observation newSpecimenObservation(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
specimen observation. This is a mandatory parameter.code
- Code for the specimen observation. This is an optional
parameter.id
- Identification of the specimen observation, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the moodCode is passed as null
.ActClass.SPCOBS
public abstract Act newPatientCareProvision(CS moodCode, CD code, SET<II> id) throws HDRRimException
PCPR (patient care provision) A patient care provision is the taking on of the responsibility by a performer for the health care of a patient or group of patients.
Discussion:The patient care event can exist without any care actions having taken place. The scope of the care is identified by Act.code.
Examples:
moodCode
- ActMood
Mood code for the
patient care provision. This is a mandatory parameter.code
- Code for the patient care provision. This is an optional
parameter.id
- identification of the patient care provision, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the moodCode is passed as null
.ActClass.PCPR
public abstract Procedure newProcedure(CS moodCode, CD code, SET<II> id) throws HDRRimException
Examples:
Procedures may involve the disruption of some body surface (e.g. an incision in a surgical procedure) conservative procedures such as reduction of a luxated join, including physiotherapy such as chiropractic treatment, massage, balneotherapy, acupuncture, shiatsu, etc. Outside of clinical medicine, procedures may be such things as alteration of environments (e.g. straightening rivers, draining swamps, building dams) or the repair or change of machinery etc.
Discussion:
Applied to clinical medicine, procedure is but one among several types of clinical activities such as observation, substance-administrations, and communicative interactions (example teaching, advice, psychotherapy, represented simply as Acts without special attributes). Procedure does not subsume those other activities nor is procedure subsumed by them. Notably, procedure does not comprise all acts of whose intent is intervention or treatment. Whether the bodily alteration is appreciated or intended as beneficial to the subject is likewise irrelevant, what counts is that the act is essentially an alteration of the physical condition of the subject.
The choice between representations for a real activities is based on whether the specific properties of procedure are applicable and whether the activity or activity step's necessary post-condition is the physical alteration. For example, taking an x-ray image may sometimes be called "procedure", but it is not a Procedure in the RIM sense for an x-ray image is not done to alter the physical condition of the body.
Many clinical activities combine acts of observation and procedure nature into one composite. For instance, interventional radiology (e.g., catheter directed thrombolysis) does both observing and treating, and most surgical procedures include conscious and documented observation steps. These clinical activities therefore are best represented by multiple component acts each of the appropriate type.
moodCode
- ActMood
Mood code for the
procedure. This is a mandatory parameter.code
- Code for the procedure. This is an optional parameter.id
- identification of the procedure, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.PROC
public abstract Act newSpecimenTreatment(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
specimen treatment. This is a mandatory parameter.code
- Code for the specimen treatment. This is an optional
parameter.id
- identification of the specimen treatment, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.SPCTRT
public abstract Supply newSupply(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
supply. This is a mandatory parameter.code
- Code for the supply. This is an optional parameter.id
- identification of the supply, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.SPLY
public abstract Diet newDiet(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
diet. This is a mandatory parameter.code
- Code for the diet. This is an optional parameter.id
- Identification of the diet, may be null
, however,
HDR will always generate an internal identifier. The II is
unique across a broad class (Act, Entity, non-owned Role)
rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.DIET
public abstract Act newTransportation(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Transportation. This is a mandatory parameter.code
- Code for the Transportation. This is an optional parameter.id
- identification of the Transportation, may be null
, however, HDR will always generate an internal identifier.
The II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.TRNS
public abstract FinancialTransaction newFinancialTransaction(CS moodCode, CD code, SET<II> id) throws HDRRimException
Act
representing
any transaction between ' two accounts whose value is measured in
monetary terms. In the "intent" mood, communicates a request for a
transaction to be initiated, or communicates a transfer of value between
two accounts. In the "event" mood, communicates the posting of a
transaction to an account.moodCode
- ActMood
Mood code for the
financial transaction. This is a mandatory parameter.code
- Code for the financial transaction. This is an optional
parameter.id
- identification of the financial transaction, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.XACT
public abstract Procedure newSpecimenCollection(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
SpecimenCollection. This is a mandatory parameter.code
- Code for the SpecimenCollection. This is an optional
parameter.id
- identification of the SpecimenCollection, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Procedure
created.HDRRimException
- when the mood code is passed as null
.ActClass.SPECCOLLECT
public abstract Act newDisciplinaryAction(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
DisciplinaryAction. This is a mandatory parameter.code
- Code for the DisciplinaryAction. This is an optional
parameter.id
- identification of the DisciplinaryAction, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.DISPACT
public abstract Act newReview(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Review. This is a mandatory parameter.code
- Code for the Review. This is an optional parameter.id
- identification of the Review, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.REV
public abstract Act newStorage(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Storage. This is a mandatory parameter.code
- Code for the Storage. This is an optional parameter.id
- identification of the Storage, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.STORE
public abstract Act newSubstitution(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Substitution. This is a mandatory parameter.code
- Code for the Substitution. This is an optional parameter.id
- identification of the Substitution, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.SUBST
public abstract Observation newVerification(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Verification. This is a mandatory parameter.code
- Code for the Verification. This is an optional parameter.id
- identification of the Verification, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Observation
created.HDRRimException
- when the mood code is passed as null
.ActClass.VERIF
public abstract Observation newPosition(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Position. This is a mandatory parameter.code
- Code for the Position. This is an optional parameter.id
- identification of the Position, may be null
,
however, HDR will always generate an internal identifier. The
II is unique across a broad class (Act, Entity, non-owned
Role) rather than across the finer grained classes of HL7.Observation
created.HDRRimException
- when the mood code is passed as null
.ActClass.POS
public abstract Observation newPositionAccuracy(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
PositionAccuracy. This is a mandatory parameter.code
- Code for the PositionAccuracy. This is an optional parameter.id
- identification of the PositionAccuracy, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Observation
created.HDRRimException
- when the mood code is passed as null
.ActClass.POSACC
public abstract Observation newPositionCoordinate(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
PositionCoordinate. This is a mandatory parameter.code
- Code for the PositionCoordinate. This is an optional
parameter.id
- identification of the PositionCoordinate, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Observation
created.HDRRimException
- when the mood code is passed as null
.ActClass.POSCOORD
public abstract Act makeReference(ReferenceModifier modifier, CS actClass, CS moodCode, CD code, SET<II> id, int versionNumber) throws HDRRimException
Creates a reference to an object that is assumed to already exist in HDR. Only the first and last argument are required.
modifier
- Controls the behavior of the reference when submitted.
Possible values include:
actClass
- Class Code of the Act
. This parameter must be
specified for CreateIf, CreateOrOverlay, CreateOrUpdate, and
Overlay modifiers.moodCode
- Mood code of the Act
. This parameter must be
specified for CreateIf, CreateOrOverlay, CreateOrUpdate, and
Overlay modifiers.code
- act code. This parameter may be null. However a null value may
result in validation failures for Overlay or CreateOrOverlay
references if an attempt is made to modify an object that has
a code.id
- Identification of the position, this is mandatory and can not
be an empty set. The II is unique across a broad class (Act,
Entity, non-owned Role) rather than across the finer grained
classes of HL7.versionNumber
- Zero or a valid positive integer. If it is zero, then the
current version will be used. For positive integer values the
behavior will vary depending on the modifier. It is ignored
for CREATE_IF references. For MUST_EXIST references, the
specified versionNumber must correspond to a version in the
database. For UPDATE or OVERLAY references the specified
versionNumber must correspond to a version in the database and
be the current version at the time of submission.
CREATE_OR_OVERLAY and CREATE_OR_UPDATE references will behave
like CREATE_IF or UPDATE/OVERLAY depending on whether an
object exists in the database.Act
object which is being referenced here. This
can be downcasted to the proper sub class of Act
based on the class code passed.HDRRimException
- under following conditions:
null
.actClass
or moodCode
is
passed as null
with ReferenceModifier as
CreateIf.actClass
is CACT and
ReferenceModifier
is not type type CREATE_IF or
MUST_EXIST.ReferenceModifier
public abstract QueryAct newQueryAct(CoreFetch fetch) throws HDRRimException
QueryAct
. Class code is set to CACT and mood code
is set to EVN. Query Acts are necessary to query HDR for stored datafetch
- The Fetch
object used to query data from
repository.QueryAct
created.HDRRimException
CoreFetch
,
ActClass.CACT
,
ActMood.EVN
public abstract Act newAcquisitionExposure(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
AcquisitionExposure. This is a mandatory parameter.code
- Code for the AcquisitionExposure. This is an optional
parameter.id
- identification of the AcquisitionExposure, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.AEXPOS
public abstract Act newConcern(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Concern. This is a mandatory parameter.code
- Code for the Concern. This is an optional
parameter.id
- identification of the Concern, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.CONC
public abstract Act newContainer(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Container. This is a mandatory parameter.code
- Code for the Container. This is an optional
parameter.id
- identification of the Container, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.CONTAINER
public abstract Observation newDeterminantPeptide(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
DeterminantPeptide. This is a mandatory parameter.code
- Code for the DeterminantPeptide. This is an optional
parameter.id
- identification of the DeterminantPeptide, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Observation
created.HDRRimException
- when the mood code is passed as null
.ActClass.DETPOL
public abstract Observation newExpressionLevel(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
ExpressionLevel. This is a mandatory parameter.code
- Code for the ExpressionLevel. This is an optional
parameter.id
- identification of the ExpressionLevel, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Observation
created.HDRRimException
- when the mood code is passed as null
.ActClass.EXP
public abstract Act newExposure(CS moodCode, CD code, SET<II> id) throws HDRRimException
public abstract Observation newGenomicObservation(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
GenomicObservation. This is a mandatory parameter.code
- Code for the GenomicObservation. This is an optional
parameter.id
- identification of the GenomicObservation, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Observation
created.HDRRimException
- when the mood code is passed as null
.ActClass.GEN
public abstract Act newGrouper(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Grouper. This is a mandatory parameter.code
- Code for the Grouper. This is an optional
parameter.id
- identification of the Grouper, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.GROUPER
public abstract Act newPublicHealthCaseV3(CS moodCode, CD code, SET<II> id) throws HDRRimException
public abstract Act newJurisdictionalPolicy(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
JurisdictionalPolicy. This is a mandatory parameter.code
- Code for the JurisdictionalPolicy. This is an optional
parameter.id
- identification of the JurisdictionalPolicy, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.JURISPOL
public abstract Act newOrganizationalPolicy(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
OrganizationalPolicy. This is a mandatory parameter.code
- Code for the OrganizationalPolicy. This is an optional
parameter.id
- identification of the OrganizationalPolicy, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.ORGPOL
public abstract Act newOutbreakV3(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Outbreak. This is a mandatory parameter.code
- Code for the Outbreak. This is an optional
parameter.id
- identification of the Outbreak, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.OUTBR
public abstract Act newPolicy(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Policy. This is a mandatory parameter.code
- Code for the Policy. This is an optional
parameter.id
- identification of the Policy, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.POLICY
public abstract Act newScopeOfPracticePolicy(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
ScopeOfPracticePolicy. This is a mandatory parameter.code
- Code for the ScopeOfPracticePolicy. This is an optional
parameter.id
- identification of the ScopeOfPracticePolicy, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.SCOPOL
public abstract Act newStandardOfPracticePolicy(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
StandardOfPracticePolicy. This is a mandatory parameter.code
- Code for the StandardOfPracticePolicy. This is an optional
parameter.id
- identification of the StandardOfPracticePolicy, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.STDPOL
public abstract Act newTransmissionExposure(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
TransmissionExposure. This is a mandatory parameter.code
- Code for the TransmissionExposure. This is an optional
parameter.id
- identification of the TransmissionExposure, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.TEXPOS
public abstract Act newTransfer(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Transfer. This is a mandatory parameter.code
- Code for the Transfer. This is an optional
parameter.id
- identification of the Transfer, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Act
created.HDRRimException
- when the mood code is passed as null
.ActClass.TRFR
public abstract Observation newLocus(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Locus. This is a mandatory parameter.code
- Code for the Locus. This is an optional
parameter.id
- identification of the Locus, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Observation
created.HDRRimException
- when the mood code is passed as null
.ActClass.LOC
public abstract Observation newPhenotype(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Phenotype. This is a mandatory parameter.code
- Code for the Phenotype. This is an optional
parameter.id
- identification of the Phenotype, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Observation
created.HDRRimException
- when the mood code is passed as null
.ActClass.PHN
public abstract Observation newPolypeptide(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
Polypeptide. This is a mandatory parameter.code
- Code for the Polypeptide. This is an optional
parameter.id
- identification of the Polypeptide, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Observation
created.HDRRimException
- when the mood code is passed as null
.ActClass.POL
public abstract Observation newBioSequence(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
BioSequence. This is a mandatory parameter.code
- Code for the BioSequence. This is an optional
parameter.id
- identification of the BioSequence, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Observation
created.HDRRimException
- when the mood code is passed as null
.ActClass.SEQ
public abstract Observation newBioSequenceVariation(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
BioSequenceVariation. This is a mandatory parameter.code
- Code for the BioSequenceVariation. This is an optional
parameter.id
- identification of the BioSequenceVariation, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Observation
created.HDRRimException
- when the mood code is passed as null
.ActClass.SEQVAR
public abstract Procedure newSubstanceExtraction(CS moodCode, CD code, SET<II> id) throws HDRRimException
moodCode
- ActMood
Mood code for the
SubstanceExtraction. This is a mandatory parameter.code
- Code for the SubstanceExtraction. This is an optional
parameter.id
- identification of the SubstanceExtraction, may be
null
, however, HDR will always generate an
internal identifier. The II is unique across a broad class
(Act, Entity, non-owned Role) rather than across the finer
grained classes of HL7.Procedure
created.HDRRimException
- when the mood code is passed as null
.ActClass.SBEXT
HDR Glossary HDR Concept Lists HDR Exceptions HDR Programmer's Guide HDR Implementation Guide HDR Profile Options
Copyright © 2016, 2018, Oracle. All rights reserved