Print Page as PDF
HEALTH SUMMARY OBJECTS API ICR (3813)

HEALTH SUMMARY OBJECTS API    ICR (3813)

Name Value
NUMBER 3813
IA # 3813
DATE CREATED 2002/10/26
CUSTODIAL PACKAGE HEALTH SUMMARY
CUSTODIAL ISC Salt Lake City
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE GMTSOBJ
NAME HEALTH SUMMARY OBJECTS API
GENERAL DESCRIPTION
This agreement details APIs that may be subscribed to
to access and edit Health Summary Objects.
STATUS Active
KEYWORDS
  • HEALTH
  • SUMMARY
  • OBJECTS
  • GMTSOBJ
DURATION Till Otherwise Agreed
ID GMTSOBJ
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$CRE(NAME)
This entry point creates a Health Summary Object with
the name provided by the input variable NAME.  If a Health Summary object of
the given name already exist, the user will be able to edit it.  This function
returns the Internal Entry Number of Object file the object is created or
edited.
VARIABLES TYPE VARIABLES DESCRIPTION
NAME Input
Freetext name of an Object to create or edit, 3 to 30
characters in length.
TYPE(NAME)
This entry point allows a user to edit a Health
Summary Type with the name provided by the input variable.
VARIABLES TYPE VARIABLES DESCRIPTION
NAME Input
Freetext of Health Summary Type to edit, 3 to 30
characters in length.
ARY(DFN,OBJ,ROOT)
This entry point will get a Health Summary Object
(OBJ), using the clinical data based on the patient provided by the input
variable DFN, and place the data in a global array defined by the input
variable ROOT.

Returns global/local array of Health Summary data

ROOT     ^TMP("GMTSOBJ",$J,DFN)
Returns  ^TMP("GMTSOBJ",$J,DFN,#)

ROOT     ^TMP("TIUHSOBJ",$J,"FGBL")
Returns  ^TMP("TIUHSOBJ",$J,"FGBL",#)

ROOT     MYARRAY
Returns  MYARRAY(#)

VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
IEN for Patient (file #2)
OBJ Input
IEN for Health Summary Object (file #142.5)
ROOT Input
Closed root (global or local array).
GET(DFN,OBJ)
This entry point will get a Health Summary Object,
using the clinical data based on the patient provided by the input variable
DFN, and place the data in a global array.

Returns Global array of Health Summary data in:

^TMP("GMTSOBJ",$J,DFN,#,0)
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
IEN for Patient (file #2)
OBJ Input
IEN for Health Summary Object (file #142.5)
$$TIU(DFN,OBJ)
Similar to GET(DFN,OBJ), but the output is formatted
for TIU.  This entry point will get a Health Summary Object (OBJ), using the
clinical data based on the patient provided by the input variable DFN, and
place the data in a global array for the Text Integration Utility (TIU).

Output    Global Root ~@^TIU("TIUHSOBJ",$J,"FGBL")
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
IEN for Patient (file #2).
OBJ Input
IEN for Health Summary Object (file #142.5).
SHOW(OBJ)
This entry point will display a Health Summary Object
Definition based on the object supplied by the input variable NAME.  It will
display the definition, followed by a short example.  If you do not need the
example displayed set the variable GMTSABBR before calling SHOW^GMTSOBJ(OBJ)
for an abbreviated display.
VARIABLES TYPE VARIABLES DESCRIPTION
OBJ Input
IEN for Health Summary Object (#142.5).
EXTRACT(OBJ,.ARY)
This entry point will extract the data from a Health
Summary Object based on the input variable OBJ, and place the data in the
array ARY, passed by reference.  This entry point eliminates the need for a
file type integration agreement for file #142.5.
VARIABLES TYPE VARIABLES DESCRIPTION
OBJ Input
IEN for Health Summary Object (file #142.5)
.ARY Input
Array to use for output, passed by reference.
ARY() Output
Array containing subscripts for the Object being
extracted (IEN), and the fields being extracted, and the format extracted.
With the exception of the Description field, all fields are extracted in the
internal format ("I"), the external format ("E"), and includes the field's
name ("NAME") and the name in mixed case ("PROMPT").

ARY(IEN,FIELD,"I") = Internal Value
ARY(IEN,FIELD,"E") = External Value
ARY(IEN,FIELD,"NAME") = Field Name
ARY(IEN,FIELD,"PROMPT") = Mixed Case of Field Name
DEF(OBJ,.ARY)
This entry point is used to extract an Health Summary
Object definition and place that definition into the array passed by
reference.  This entry point will also include an pseudo-example of the
object.
VARIABLES TYPE VARIABLES DESCRIPTION
OBJ Input
IEN of the Health Summary Object file (#142.5).
.ARY Input
Array to receive the definition, passed by reference.

ARY() Output
Output array containing the Health Summary Object
Definition and Example, passed by reference.

ARY("D",0) = # of lines in Definition
ARY("D",#) = Definition Text
ARY("E",0) = # of lines in Example
ARY("E",#) = Example Text
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC SUBSCRIBING DETAILS
TEXT INTEGRATION UTILITIES Salt Lake City
Text Integration Utilities need these APIs to embed
Health Summary Objects in TIU documents, to create Health Summary Objects, and
to edit Health Summary Objects.

MAIL MESSAGE 35213487