CAM Template: EDXL-subset-template.cam

C:/Documents%20and%20Settings/dwebber/My%20Documents/CAM/EDXL

Owner OASIS EDXL TC
Version 0.5
Description OASIS EDXL Implementation Guide (draft)
Date 2007-12-15T12:56:58

Assembly Structures

Structure

ID: EDXL-subset

Taxonomy: XML

XPath locator
Rule(s)
Annotation
asm1:HospitalStatus
makeMandatory()
  
Definition
The top level container element for reporting status of any number of hospitals. The EDXL-HAVE has no independent routing mechanism, so it requires a routing mechanism that is consistent with the EDXL-DE distribution types. It must contain one or more Hospital elements.
  
  asm1:Hospital
makeMandatory()
  
  
    asm1:Organization
makeMandatory()
  
Definition
The container element for organization information elements. The generic element Organisation refers to the entity that is providing the data. This generic name is used throughout this document. Typically, this will include hospitals, nursing care centers, trauma centers etc.
  
      asm1:OrganizationInformation
makeMandatory()
  
  
        @ns6:Usage
makeOptional()
  
  
        @ns6:Status
makeOptional()
  
  
        @ns1:DateValidFrom
setDateMask(YYYY-MM-DD'T'HH:MI:SS.S'Z')
  
  
        @ns1:DateValidTo
setDateMask(YYYY-MM-DD'T'HH:MI:SS.S'Z')
makeOptional()
  
  
        @ns6:OrganisationDetailsKey
makeOptional()
  
  
        @ns6:OrganisationDetailsKeyRef
makeOptional()
  
  
        @ns3:type
  
  
        @ns3:label
makeOptional()
  
  
        @ns3:href
makeOptional()
  
  
        @ns1:LanguageCode
makeOptional()
  
  
        ns6:FreeTextLines
makeOptional()
  
  
          ns6:FreeTextLine
makeRepeatable()
  
  
            @ns6:Type
makeOptional()
  
  
        ns7:OrganisationName
makeMandatory()
  
  
          @ns7:Type
  
  
          @ns7:OrganisationID
makeOptional()
  
  
          @ns7:OrganisationIDType
makeOptional()
  
  
          @ns7:ID
makeOptional()
  
  
          @ns7:Status
makeOptional()
  
  
          @type
makeOptional()
  
  
          @ns3:href
makeOptional()
  
  
          @ns1:LanguageCode
makeOptional()
  
  
        ns6:Addresses
makeMandatory()
  
  
          ns6:Address
makeMandatory()
  
  
            @ns5:Type
  
  
            @ns5:ID
makeOptional()
  
  
            @ns3:type
  
  
            @ns3:href
makeOptional()
  
  
            @ns1:LanguageCode
makeOptional()
  
  
            ns5:FreeTextAddress
makeMandatory()
  
  
              ns5:AddressLine
makeRepeatable()
  
  
                @ns5:Type
  
  
            ns5:Country
makeMandatory()
  
  
              ns5:NameElement
makeMandatory()
  
  
                @ns5:NameType
  
  
                @ns5:NameCode
  
  
                @ns5:NameCodeType
  
  
                @ns1:Abbreviation
  
  
            ns5:AdministrativeArea
makeMandatory()
  
  
              @ns5:Type
  
  
              ns5:NameElement
if //ns5:AdministrativeArea/@ns5:Type='State'

then
lookup(US-Full-Valid-State-Codes))
end if;
  
  
                @ns1:Abbreviation
  
  
              ns5:SubAdministrativeArea
makeOptional()
  
  
                @ns5:Type
  
  
                ns5:NameElement
makeMandatory()
  
  
                  @ns1:Abbreviation
  
  
            ns5:Thoroughfare
makeMandatory()
  
  
              ns5:Number
makeMandatory()
  
  
              ns5:NameElement
makeMandatory()
  
  
                @ns5:NameType
  
  
            ns5:PostCode
makeMandatory()
  
  
              ns5:Identifier
makeRepeatable()
  
  
                @ns5:Type
restrictValues('USZIP'|'POSTCODE'|'REGION')
  
  
                @ns1:Abbreviation
makeOptional()
restrictValues('true'|'false')
  
  
        ns6:ContactNumbers
makeOptional()
  
  
          ns6:ContactNumber
makeRepeatable()
  
  
            @ns6:CommunicationMediaType
restrictValues('Cellphone'|'Pager'|'MainDesk'|'SwitchBoard'|'ER'|'OnCall')
  
  
            @ns6:Status
makeOptional()
  
  
            @ns6:Usage
makeOptional()
  
  
            @ns6:ContactHours
makeOptional()
  
  
            @ns1:DateValidFrom
makeOptional()
  
  
            @ns1:DateValidTo
makeOptional()
  
  
            ns6:ContactNumberElement
makeMandatory()
  
  
              @ns6:Type
makeOptional()
  
  
          ns6:ContactNumber
makeRepeatable()
  
  
            @ns6:CommunicationMediaType
restrictValues('Cellphone'|'Pager'|'MainDesk'|'SwitchBoard'|'ER'|'OnCall')
  
  
            @ns6:Status
makeOptional()
  
  
            @ns6:Usage
makeOptional()
  
  
            @ns6:ContactHours
makeOptional()
  
  
            @ns1:DateValidFrom
makeOptional()
  
  
            @ns1:DateValidTo
makeOptional()
  
  
            ns6:ContactNumberElement
makeMandatory()
  
  
              @ns6:Type
makeOptional()
  
  
        ns6:ElectronicAddressIdentifiers
makeMandatory()
  
  
          ns6:ElectronicAddressIdentifier
makeRepeatable()
  
  
            @ns6:Type
  
  
            @ns6:Status
makeOptional()
  
  
        ns6:Revenues
makeMandatory()
  
  
          ns6:Revenue
makeMandatory()
  
  
            @ns6:CurrencyCode
  
  
            @ns6:Status
makeOptional()
  
  
            @ns6:PeriodFrom
  
  
            @ns6:PeriodTo
  
  
            @ns6:Type
makeOptional()
  
  
            @ns6:Precision
makeOptional()
  
  
            @ns6:Source
  
  
            @ns6:CountryName
makeOptional()
  
  
            @ns6:AfterTax
restrictValues('true'|'false')
makeOptional()
  
  
        ns6:Vehicles
makeOptional()
  
  
          ns6:Vehicle
makeRepeatable()
  
  
            @ns6:Type
  
  
            @ns6:Status
  
  
            ns6:VehicleElement
makeMandatory()
  
  
              @ns6:Type
  
  
        ns6:OrganisationInfo
makeMandatory()
  
  
          @ns6:Type
  
  
          @ns6:CategoryType
  
  
          @ns6:Status
  
  
          @ns6:NumberOfEmployees
  
  
      asm1:OrganizationGeoLocation
makeOptional()
  
  
        ns8:Point
makeOptional()
  
  
          @ns8:id
makeOptional()
  
  
          ns8:pos
makeMandatory()
  
  
            @srsName
makeOptional()
  
  
            @srsDimension
makeOptional()
  
  
            @axisLabels
makeOptional()
  
  
            @uomLabels
makeOptional()
  
  
      asm1:CommentText
makeOptional()
  
  
    asm1:EmergencyDepartmentStatus
makeMandatory()
  
Definition
Report on the emergency department status for the organization.
  
      asm1:EMSTraffic
makeOptional()
  
Definition
Ability of this emergency department to receive patients via emergency medical services.
  
        asm1:EMSTrafficStatus
restrictValues('Normal'|'Advisory'|'Closed'|'NotApplicable')
  
Definition
Identifies the status of EMS traffic operations
  
        asm1:EMSTrafficReason
makeOptional()
  
Definition
It is used to report the contributing factor to an EMSTraffic Status.
  
        asm1:CommentText
makeOptional()
  
  
      asm1:EMSCapacity
makeOptional()
  
Definition
The number of each triage patient type the hospital can accept.
  
        asm1:TriageCodeListURN
makeOptional()
  
  
        asm1:TriageCode
makeMandatory()
  
  
          asm1:TriageCodeValue
makeMandatory()
  
Definition
The list of values must be from the list identified in TriageCodeListURN. Default Values - Red: Number of victims with immediate needs - Yellow: Number of victims with delayed needs - Green: Number of victims with minor needs -Black: Number of deceased victims. If a TriageCodeValue is specified, a TriageCountQuantity element must be specified.
  
          asm1:TriageCountQuantity
makeMandatory()
  
Definition
The integer value associated with the TrageCodeValue. It refers to the preceeding TriageCodeValue element. If a TriageCodeValue is specified, a TriageCountQuantity element must be specified.
  
      asm1:EMSCensus
makeOptional()
  
Definition
The number of each triage patient type the hospital currently has.
  
        asm1:TriageCodeListURN
makeOptional()
  
  
        asm1:TriageCode
makeMandatory()
  
  
          asm1:TriageCodeValue
makeMandatory()
  
Definition
The list of values must be from the list identified in TriageCodeListURN. Default Values - Red: Number of victims with immediate needs - Yellow: Number of victims with delayed needs - Green: Number of victims with minor needs -Black: Number of deceased victims. If a TriageCodeValue is specified, a TriageCountQuantity element must be specified.
  
          asm1:TriageCountQuantity
makeMandatory()
  
Definition
The integer value associated with the TrageCodeValue. It refers to the preceeding TriageCodeValue element. If a TriageCodeValue is specified, a TriageCountQuantity element must be specified.
  
      asm1:EMSAirTransportStatus
makeOptional()
makeOptional()
  
Definition
The container element to indicate the status and offload time for ambulance capabilities.
  
        asm1:EMSOffloadStatus
makeMandatory()
  
  
        asm1:EMSOffloadMinutes
makeMandatory()
  
  
      asm1:EMSAmbulanceStatus
makeOptional()
makeOptional()
  
Definition
The container element to indicate the status and offload time for air transport capabilities.
  
        asm1:EMSOffloadStatus
makeMandatory()
  
  
        asm1:EMSOffloadMinutes
makeMandatory()
  
  
      asm1:CommentText
makeOptional()
makeOptional()
  
  
    asm1:HospitalBedCapacityStatus
makeOptional()
  
Definition
The hospital bed capacity for the organization.
  
      asm1:BedCapacity
makeRepeatable()
  
Definition
Container element to identify the number of available beds. Each Bed Type and the sub-categories under it must be encapsulated by a BedCapacity element. Multiple instances of BedCapacity elements are allowed. For example, a hospital may sub-categorize Adult ICU beds into Surgery, Cardiac, General and Neuro.
  
        asm1:BedType
restrictValues('AdultICU'|'PediatricICU'|'NeonatalICU'| 'EmergencyDepartment'|'NurseryBeds'|'MedicalSurgical'| 'RehabLongTermCare'|'Burn'|'Pediatrics'|'AdultPsychiatric'|'PediatricPsychiatric'| 'NegativeFlowIsolation'|'OtherIsolation'| 'OperatingRooms')
  
Definition
Enumerated list of available Bed Types
  
        asm1:SubCategoryBedType
makeOptional()
  
Definition
The name of the sub-category bed type. Each bed type (AdultICU, MedicalSurgical, etc.) may optionally contain a collection of named sub-categories. - Each bed type may have many one or more named sub-type categories. - If one or more sub category bed types are used, they must be preceded by the parent BedType element. In this case, CapacityStatus of the Bed Type CANNOT be Not Available. - Each parent BedType element and its associated sub-category bed types must be encapsulated with a BedCapacity element. - If the capacity counts of sub-category beds are specified, they need not equal the capacity count of the parent bed type. - In general, if capacities of are specified using sub-category bed types, then only the CapacityStatus of the parent bed type should be used, and this should reflect an 'Available' value.
  
        asm1:Capacity
makeMandatory()
  
Definition
Container element to define the capacity information of each specified bed type or sub category bed type.
  
          asm1:CapacityStatus
restrictValues('Vacant/Available'|'NotAvailable')
  
Definition
Indicator of status of bed type or sub-category bed type.
  
          asm1:AvailableCount
setNumberMask(####)
  
Definition
The number of vacant/available beds to which patients can be immediately transported. These must include supporting space, equipment, medical material, ancillary and support services and staff to operate under normal circumstances. These beds are licensed, physically available and have staff on hand to attend to the patient who occupies the bed.
  
          asm1:BaselineCount
setNumberMask(####)
  
Definition
The maximum (baseline) number of beds in this category.
  
          asm1:AdditionalCapacityCount24Hr
setNumberMask(####)
  
Definition
Estimate how many beds above the current number could be made vacant/available within 24 hours. This includes institutional surge beds as well as beds made available by discharging/transferring patients.
  
          asm1:AdditionalCapacityCount72Hr
setNumberMask(####)
  
Definition
Estimate how many beds above the current number could be made vacant/available within 72 hours. This includes institutional surge beds as well as beds made available by discharging/transferring patients.
  
        asm1:CommentText
makeOptional()
  
  
    asm1:ServiceCoverageStatus
makeOptional()
  
Definition
The physician service coverage status for the organization.
  
      asm1:Burn
restrictValues('true'|'false')
makeOptional()
  
Definition
The availability of Burn center services.
  
      asm1:CardiologyIndicator
makeOptional()
  
Definition
The container element for specifying the availability of Cardiology services.
  
        asm1:Cardiology
makeMandatory()
  
  
      asm1:Dialysis
restrictValues('true'|'false')
makeOptional()
  
Definition
The availability of dialysis services.
  
      asm1:EmergencyDepartment
restrictValues('true'|'false')
makeOptional()
  
Definition
The availability of Emergency Department services.
  
      asm1:HyperbaricChamber
restrictValues('true'|'false')
makeOptional()
  
Definition
The availability of hyperbaric chamber services for decompression and/or wound care.
  
      asm1:InfectiousDisease
restrictValues('true'|'false')
makeOptional()
  
Definition
The availability of Infectious Diseases.
  
      asm1:Neonatology
restrictValues('true'|'false')
makeOptional()
  
Definition
The availability of Neonatology services.
  
      asm1:NeurologyIndicator
makeOptional()
  
Definition
The container element for specifying the availability of Neurology services.
  
        asm1:Neurology
restrictValues('true'|'false')
  
  
      asm1:OBGYNIndicator
makeOptional()
  
  
        asm1:OBGYN
restrictValues('true'|'false')
  
  
      asm1:Ophthalmology
makeOptional()
restrictValues('true'|'false')
  
Definition
The availability of Ophthalmology services.
  
      asm1:Orthopedic
makeOptional()
restrictValues('true'|'false')
  
Definition
The availability of Orthopedic services.
  
      asm1:Pediatrics
makeOptional()
  
Definition
The availability of pediatric services.
  
      asm1:PsychiatricIndicator
makeOptional()
  
Definition
The container element for specifying the availability of psychiatric services.
  
        asm1:PsychiatricSubType
makeMandatory()
  
  
          asm1:PsychiatricAdultGeneral
restrictValues('true'|'false')
  
  
          asm1:PsychiatricPediatric
restrictValues('true'|'false')
  
  
      asm1:SurgeryIndicator
makeOptional()
  
Definition
The container element for specifying the availability of surgery services.
  
        asm1:SurgerySubType
makeMandatory()
  
  
          asm1:General
restrictValues('true'|'false')
makeOptional()
  
  
          asm1:AdultGeneralSurgery
restrictValues('true'|'false')
makeOptional()
  
  
          asm1:Pediatrics
restrictValues('true'|'false')
makeOptional()
  
  
          asm1:Orthopedics
restrictValues('true'|'false')
makeOptional()
  
  
          asm1:Neurosurgery
restrictValues('true'|'false')
makeOptional()
  
  
          asm1:Facial
restrictValues('true'|'false')
makeOptional()
  
  
          asm1:CardioThoracic
restrictValues('true'|'false')
makeOptional()
  
  
          asm1:Hand
restrictValues('true'|'false')
makeOptional()
  
  
          asm1:Reimplantation
restrictValues('true'|'false')
makeOptional()
  
  
          asm1:Spinal
restrictValues('true'|'false')
makeOptional()
  
  
          asm1:Vascular
restrictValues('true'|'false')
makeOptional()
  
  
          asm1:Anesthesia
restrictValues('true'|'false')
makeOptional()
  
  
      asm1:TransportServicesIndicator
makeOptional()
  
Definition
The container element for specifying the availability of transport services.
  
        asm1:TransportServices
restrictValues('true'|'false')
  
  
      asm1:TraumaCenterServicesIndicator
makeOptional()
  
Definition
The container element for specifying the availability of Trauma Center Services and its service level.
  
        asm1:TraumaCenterServices
restrictValues('true'|'false')
  
  
        asm1:TraumaCenterServicesLevel
restrictValues('Level1'|'Level2'|'Level3'|'Level4'|'Level5')
makeOptional()
  
  
      asm1:CommentText
makeOptional()
  
  
    asm1:HospitalFacilityStatus
makeOptional()
  
Definition
The status of operations for the organization.
  
      asm1:HospitalEOCStatus
restrictValues('Inactive'|'Active')
makeOptional()
  
Definition
Whether the Hospital EOC is currently operating.
  
      asm1:HospitalEOCPlan
restrictValues('Inactive'|'Active')
makeOptional()
  
Definition
Whether the Hospital EOC has activated its Emergency Operations Plan (EOP).
  
      asm1:ClinicalStatus
restrictValues('Normal'|'Full')
makeOptional()
  
Definition
The clinical status of the facility.
  
      asm1:DeconCapacity
makeOptional()
  
Definition
The status of Decon Capacity
  
        asm1:DeconCapacityStatus
restrictValues('Inactive'|'Open'|'Full'|'Exceeded')
makeOptional()
  
  
        asm1:AmubulatoryPatientsDeconCapacity
makeOptional()
setNumberMask(###)
  
  
        asm1:NonAmbulatoryPatientsDeconCapacity
makeOptional()
setNumberMask(###)
  
  
      asm1:MorgueCapacity
makeOptional()
  
Definition
The status of the morgue capacity.
  
        asm1:MorgueCapacityStatus
makeOptional()
  
  
        asm1:MorgueCapacityUnits
makeOptional()
setNumberMask(###)
  
  
      asm1:FacilityStatus
restrictValues('Normal'|'Closed'|'Compromised'|'Evacuating')
makeOptional()
  
Definition
The status of the facility.
  
      asm1:SecurityStatus
restrictValues('Normal'|'Elevated'|'RestrictedAccess'|'Lockdown'|'Quarantine')
makeOptional()
  
Definition
The status of security procedures in the hospital.
  
      asm1:Activity24Hr
makeOptional()
  
Definition
The container element for reporting activities in the last 24 hours.
  
        asm1:Admissions
setNumberMask(###)
makeOptional()
  
  
        asm1:Discharges
setNumberMask(###)
makeOptional()
  
  
        asm1:Deaths
setNumberMask(###)
makeOptional()
  
  
      asm1:CommentText
makeOptional()
makeRepeatable()
  
  
    asm1:HospitalResourcesStatus
makeOptional()
  
Definition
The status of resources for the organization.
  
      asm1:Staffing
restrictValues('Adequate'|'Insufficient')
makeOptional()
  
Definition
The status of staffing.
  
      asm1:FacilityOperations
restrictValues('Adequate'|'Insufficient')
makeOptional()
  
Definition
The status of supplies necessary for facility operations.
  
      asm1:ClinicalOperations
restrictValues('Adequate'|'Insufficient')
makeOptional()
  
Definition
The status of supplies necessary for clinical operations.
  
      asm1:ResourcesInformationText
makeRepeatable()
makeOptional()
  
Definition
The type of resources and their status or count.
  
      asm1:CommentText
makeRepeatable()
makeOptional()
  
  
    asm1:LastUpdateTime
setDateMask(YYYY-MM-DD'T'HH:MI:SS.S'Z')
  
Definition
The last time the information was updated.
  

LookupList: US-Full-Valid-State-Codes

Name
Type
Value
Alternative
ALABAMA
.
AL
.
ALASKA
.
AK
.
AMERICAN SAMOA
.
AS
.
ARIZONA
.
AZ
.
ARKANSAS
.
AR
.
Armed Forces Africa
.
AE
.
Armed Forces Americas
.
AA
.
Armed Forces Canada
.
AE
.
Armed Forces Europe
.
AE
.
Armed Forces Middle East
.
AE
.
Armed Forces Pacific
.
AP
.
CALIFORNIA
.
CA
.
COLORADO
.
CO
.
CONNECTICUT
.
CT
.
DELAWARE
.
DE
.
DISTRICT OF COLUMBIA
.
DC
.
FEDERATED STATES OF MICRONESIA
.
FM
.
FLORIDA
.
FL
.
GEORGIA
.
GA
.
GUAM
.
GU
.
HAWAII
.
HI
.
IDAHO
.
ID
.
ILLINOIS
.
IL
.
INDIANA
.
IN
.
IOWA
.
IA
.
KANSAS
.
KS
.
KENTUCKY
.
KY
.
LOUISIANA
.
LA
.
MAINE
.
ME
.
MARSHALL ISLANDS
.
MH
.
MARYLAND
.
MD
.
MASSACHUSETTS
.
MA
.
MICHIGAN
.
MI
.
MINNESOTA
.
MN
.
MISSISSIPPI
.
MS
.
MISSOURI
.
MO
.
MONTANA
.
MT
.
NEBRASKA
.
NE
.
NEVADA
.
NV
.
NEW HAMPSHIRE
.
NH
.
NEW JERSEY
.
NJ
.
NEW MEXICO
.
NM
.
NEW YORK
.
NY
.
NORTH CAROLINA
.
NC
.
NORTH DAKOTA
.
ND
.
NORTHERN MARIANA ISLANDS
.
MP
.
OHIO
.
OH
.
OKLAHOMA
.
OK
.
OREGON
.
OR
.
PALAU
.
PW
.
PENNSYLVANIA
.
PA
.
PUERTO RICO
.
PR
.
RHODE ISLAND
.
RI
.
SOUTH CAROLINA
.
SC
.
SOUTH DAKOTA
.
SD
.
TENNESSEE
.
TN
.
TEXAS
.
TX
.
UTAH
.
UT
.
VERMONT
.
VT
.
VIRGIN ISLANDS
.
VI
.
VIRGINIA
.
VA
.
WASHINGTON
.
WA
.
WEST VIRGINIA
.
WV
.
WISCONSIN
.
WI
.
WYOMING
.
WY
.

LookupList: EDXL-bedtypes

Name
Type
Value
Alternative
Capacity status for negative airflow isolation beds. These provide respiratory isolation. NOTE: This value may represent available beds included in the counts of other types.
.
NegativeFlowIsolation
.
Capacity status for operating rooms which are equipped staffed and could be made available for patient care in a short period of time.
.
OperatingRooms
.
Capacity status for other isolation beds. These provide isolation where airflow is not a concern. NOTE: This value may represent available beds included in the counts of other types.
.
OtherIsolation
.
Capacity status for pediatrics beds. These are ward medical/surgical beds for patients 17-years-old and younger.
.
Pediatrics
.
Capacity status for psychiatric beds. These are ward beds on a closed/locked psychiatric unit or ward beds where a patient will be attended by a sitter.
.
AdultPsychiatric
.
EmergencyDepartment
.
EmergencyDepartment
.
NeonatalICU
.
NeonatalICU
.
NurseryBeds
.
NurseryBeds
.
PediatricICU
.
PediatricICU
.
PediatricPsychiatric
.
PediatricPsychiatric
.
RehabLongTermCare
.
RehabLongTermCare
.
These are also thought of as ward beds. These beds may or may not include cardiac telemetry capability.
.
MedicalSurgical
.
These are thought of as burn ICU beds, either approved by the American Burn Association or self-designated. These beds are NOT to be included in other ICU bed counts.
.
Burn
.
These can support critically ill or injured patients, including ventilator support. This category includes all major subtypes of ICU beds, including neuro, cardiac, trauma, or medical, with the exception that this category does not include burn ICU beds.
.
AdultICU
.