| PRPA_MT900300UV02 Find Encounters Query |
Derived from RMIM: PRPA_RM900300UV02 and HMD: PRPA_HD900300UV02 |
||||||||
| QueryByParameterPayload |
Design Comments: Entry point for the Find Encounters Query payload message |
||||||||
| queryId [0..1] QueryByParameter (II) |
Design Comments: Identifier for the query. It is used to associate this query instance with both the initial response message and with later query interactions. Valuing queryId avoids the need for the QueryContinuation and QueryAck classes to carry as much detail information as is carried in the initial query. |
||||||||
| statusCode [1..1] (M) QueryByParameter (CS) {CNE:V:QueryStatusCode} |
|||||||||
| modifyCode [0..1] QueryByParameter (CS) {CNE:V:ModifyIndicator} |
Design Comments: Indicates whether the subscription to a query is new or is being modified |
||||||||
| responseElementGroupId [0..*] QueryByParameter (DSET<II>) |
Design Comments: Identifies the specific message type to be returned in the query response. The message type is constrained to the set of message types supported by the receiver responsibilities associated with the query interaction. |
||||||||
| responseModalityCode [0..1] QueryByParameter (CS) {CNE:V:ResponseModality} |
Design Comments: Defines the timing and grouping of the response instances |
||||||||
| responsePriorityCode [0..1] QueryByParameter (CS) {CNE:V:QueryPriority} |
Design Comments: Identifies the time frame in which a response is expected |
||||||||
| initialQuantity [0..1] QueryByParameter (INT.POS) |
Design Comments: Defines the maximum size of the response that can be accepted by the requesting application. |
||||||||
| initialQuantityCode [0..1] QueryByParameter (CD) {CWE:D:QueryRequestLimit} |
Design Comments: Defines the units associated with the initialQuantity |
||||||||
| careEventID [0..1] (CareEventID) |
Design Comments: This parameter is the identifier of an overall care event of which a patient encounter is a component. A care event represents someone (generally a health care practitioner) taking responsibility for some aspect of a patient's health; examples include primary/preferred care provider, case manager. |
||||||||
| encounterStatus [0..1] (EncounterStatus) |
Design Comments: This query parameter is the status of a patient encounter. For example, only encounters that are "active" or only encounters that are "completed". |
||||||||
| encounterTimeframe [0..1] (EncounterTimeframe) |
Design Comments: This parameter is the patient encounter time interval starting with the administrative onset of the encounter (e.g. admission, registration, patient arrival) and ending with the patient's departure (e.g. discharge). NOTES: (1) This parameter works with the EncounterStatus parameter to constrain the responses to those encounters that had a given status within the timeframe as specified by this parameter. (2) It affects encounters whose effectiveTime overlaps with any part of the timeframe specified in this parameter. (3) This parameter does NOT constrain the participations in any way, i.e. if an encounter overlaps with the timeframe specified by this parameter, ALL participations -regardless of their effectivetime- shall be returned. |
||||||||
| patientId [1..1] (PatientId) |
Design Comments: This query parameter is the identifier of the patient that is the subject of an encounter. |
||||||||
| patientLocationID [0..*] (PatientLocationID) |
Design Comments: This parameter is an identifier for a patient's assigned location during a patient encounter. |
||||||||
| responsibleOrganization [0..1] (ResponsibleOrganization) |
Design Comments: This query parameter is the identifer of a healthcare provider organization that holds clinical responsibility for a patient encounter. |
||||||||
| sortControl [0..*] (SortControl) |
Design Comments: This class allows the query requester to specify the order in which the server should return multiple results. |
||||||||
| typeOfEncounter [0..1] (TypeOfEncounter) |
Design Comments: This query parameter is the type of patient encounter such as "ambulatory", "inpatient", or "emergency". |
||||||||
| CareEventID |
Design Comments: This parameter is the identifier of an overall care event of which a patient encounter is a component. A care event represents someone (generally a health care practitioner) taking responsibility for some aspect of a patient's health; examples include primary/preferred care provider, case manager. |
||||||||
| value [1..*] (M) ParameterItem (DSET<II>) |
Design Comments: An instance identifier consisting of an OID root and optionally an extension. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [0..1] ParameterItem (ST){default= "CareEvent.id"} |
|||||||||
| EncounterStatus |
Design Comments: This query parameter is the status of a patient encounter. For example, only encounters that are "active" or only encounters that are "completed". |
||||||||
| value [1..*] (M) ParameterItem (DSET<CV>) {CNE:D:ActStatus} |
Design Comments: A code from the HL7 ActStatus code system. |
||||||||
| semanticsText [0..1] ParameterItem (ST){default= "Encounter.statusCode"} |
|||||||||
| EncounterTimeframe |
Design Comments: This parameter is the patient encounter time interval starting with the administrative onset of the encounter (e.g. admission, registration, patient arrival) and ending with the patient's departure (e.g. discharge). NOTES: (1) This parameter works with the EncounterStatus parameter to constrain the responses to those encounters that had a given status within the timeframe as specified by this parameter. (2) It affects encounters whose effectiveTime overlaps with any part of the timeframe specified in this parameter. (3) This parameter does NOT constrain the participations in any way, i.e. if an encounter overlaps with the timeframe specified by this parameter, ALL participations -regardless of their effectivetime- shall be returned. |
||||||||
| value [1..1] (M) ParameterItem (IVL<TS>) |
Design Comments: A time interval whose start represents the beginning of a patient encounter and whose end (if specified) represents the end of a patient encounter. |
||||||||
| semanticsText [0..1] ParameterItem (ST){default= "Encounter.effectiveTime"} |
|||||||||
| PatientId |
Design Comments: This query parameter is the identifier of the patient that is the subject of an encounter. |
||||||||
| value [1..*] (M) ParameterItem (DSET<II>) |
Design Comments: An instance identifier consisting of an OID root and optionally an extension. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [0..1] ParameterItem (ST){default= "Patient.ID"} |
|||||||||
| PatientLocationID |
Design Comments: This parameter is an identifier for a patient's assigned location during a patient encounter. |
||||||||
| value [1..1] (M) ParameterItem (DSET<II>) |
Design Comments: An instance identifier consisting of an OID root and optionally an extension. |
||||||||
| semanticsText [0..1] ParameterItem (ST){default= "Encounter.location.ServiceDeliveryLocation.id"} |
|||||||||
| ResponsibleOrganization |
Design Comments: This query parameter is the identifer of a healthcare provider organization that holds clinical responsibility for a patient encounter. |
||||||||
| value [1..*] (M) ParameterItem (DSET<II>) |
Design Comments: An instance identifier consisting of an OID root and optionally an extension. Multiple instances within a single parameter are combined with OR logic. |
||||||||
| semanticsText [0..1] ParameterItem (ST){default= "ResponsibleOrganization.id"} |
|||||||||
| SortControl |
Design Comments: This class allows the query requester to specify the order in which the server should return multiple results. |
||||||||
| sequenceNumber [0..1] SortControl (INT.NONNEG) |
Design Comments: Specifies the order of this elementName in the sort |
||||||||
| elementName [0..1] SortControl (SC.NT) {CWE:D:ElementName} |
Design Comments: Identifies the element upon which the response should be sorted |
||||||||
| directionCode [0..1] SortControl (CS) {CNE:V:Sequencing} |
Design Comments: Specifies sort order (ascending, descending or none) |
||||||||
| TypeOfEncounter |
Design Comments: This query parameter is the type of patient encounter such as "ambulatory", "inpatient", or "emergency". |
||||||||
| value [1..1] (M) ParameterItem (DSET<CD>) {CWE:V:ActEncounterCode} |
Design Comments: A value from the HL7 ActEncounter value set such as "ambulatory", "inpatient", or "emergency". |
||||||||
| semanticsText [0..1] ParameterItem (ST){default= "Encounter.code"} |
|||||||||