| POLB_MT300000UV01 Query |
Derived from RMIM: POLB_RM300000UV01 and HMD: POLB_HD300000UV01 |
||||||||
| QueryByParameterPayload |
Design Comments: Entry is into the QueryByParameter class with the local name QueryByParameterPayload. This class contains the definition of a Query by Parameter. The query format is considered a closed query because a data server specifies a fixed list of parameters published in a query conformance statement. |
||||||||
| queryId [0..1] QueryByParameter (II) |
Design Comments: This attribute may be valued by the initiating application to identify the query. It is intended to be used to match response messages to the originating query. |
||||||||
| statusCode [1..1] (M) QueryByParameter (CS) {CNE:V:QueryStatusCode} |
Design Comments: The state of the QueryEvent. QueryByParameter is a specialization of the QueryEvent, hence it uses the QueryEvent state machine. |
||||||||
| 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. This message type must be choosen from 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 the 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:QueryQuantityUnit} |
Design Comments: Defines the units associated with the magnitude of the maximum size limit of a query response that can be accepted by the requesting application. |
||||||||
| actId [0..*] (ActId) |
Design Comments: This parameter is the set of Observation Act identifiers being queried |
||||||||
| actMoodCode [1..1] (ActMoodCode) |
Design Comments: The mood of the observation event is fixed at EVN. |
||||||||
| investigativeSubjectID [0..*] (InvestigativeSubjectID) |
Design Comments: The purpose of the R_InvestigativeSubject CMET is to encapsulate the subject of a public health investigation so that this information can be easily included in models outside the Public Health domain. The Investigative Subject role is scoped by the organization which is sponsoring the investigation. The role is played by the entity being investigated, which may be virtually any sort of entity (person, animal, place, material, manufactured material, etc.). |
||||||||
| observationEffectiveTime [0..*] (ObservationEffectiveTime) |
Design Comments: This carries a range of time within which the observations occurred. |
||||||||
| observationStatusCode [0..*] (ObservationStatusCode) |
Design Comments: This is the status of the observation being queried. |
||||||||
| observationType [0..*] (ObservationType) |
Design Comments: This carries an Observation type code as the parameter. |
||||||||
| patientAdministrativeGender [0..1] (PatientAdministrativeGender) |
Design Comments: This carries a patient administrative gender parameter. |
||||||||
| patientDOB [0..1] (PatientDOB) |
Design Comments: This carries a Patient date of birth parameter. |
||||||||
| patientID [0..*] (PatientID) |
Design Comments: A ParameterItem represents name, value pair which identifies a parameter and the value of the parameter to be used for a query. In this case the parameter is a set of Patient identifiers. |
||||||||
| patientName [0..*] (PatientName) |
Design Comments: This carries a patient name parameter. |
||||||||
| processStepCode [0..*] (ProcessStepCode) |
Design Comments: The means by which the act is carried out. For Specimen Collection, this is generally the collection method such as 'biopsy', 'fine needle aspiration', etc. |
||||||||
| processStepEffectiveTime [0..*] (ProcessStepEffectiveTime) |
Design Comments: Includes such events as: Specimen received in lab, Container registration, Specimen accession, Specimen treatment |
||||||||
| providerID [0..*] (ProviderID) |
Design Comments: This is the authoring provider for the observation. |
||||||||
| sortControl [0..*] (SortControl) |
Design Comments: Holds specification of sort order for instance matches to a query. |
||||||||
| specimenCollectionProcessEffectiveTime [0..*] (SpecimenCollectionProcessEffectiveTime) |
Design Comments: The time specimen was collected |
||||||||
| ActId |
Design Comments: This parameter is the set of Observation Act identifiers being queried |
||||||||
| value [1..1] (M) ParameterItem (DSET<II>) |
Design Comments: The parameter value being sent with the query. In this case it will be identifiers for observations using a SET<II> (set of instance id's) as the data type. |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: Provides a unique identification to a specific element in an identified response structure. In this case it is Act.id |
||||||||
| ActMoodCode |
Design Comments: The mood of the observation event is fixed at EVN. |
||||||||
| value [1..1] (M) ParameterItem (CV) {CNE:C:ActMood:EVN, fixed value= "EVN"} |
Design Comments: The parameter value being sent with the query. In this case it will be fixed to EVN. |
||||||||
| semanticsText [1..1] ParameterItem (ST) |
Design Comments: Provides the mood code for the root act associated with the result. UsageNotes: ERROR - Business name from Visio is too long and was truncated. Full businessName follows. (ObservationReport.moodCode, ObservationBattery.moodCode, SpecimenObservationCluster.moodCode, ObservationEvent.moodCode |
||||||||
| InvestigativeSubjectID |
Design Comments: The purpose of the R_InvestigativeSubject CMET is to encapsulate the subject of a public health investigation so that this information can be easily included in models outside the Public Health domain. The Investigative Subject role is scoped by the organization which is sponsoring the investigation. The role is played by the entity being investigated, which may be virtually any sort of entity (person, animal, place, material, manufactured material, etc.). |
||||||||
| value [1..*] (M) ParameterItem (DSET<II>) |
Design Comments: The unique identifier of a public health InvestigativeSubject (InvestigativeSubject.id). The InvestigativeSubject may be any sort of entity (person, animal, place, material, manufactured material, etc). |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: The unique identifier of a public health InvestigativeSubject (InvestigativeSubject.id). The InvestigativeSubject may be any sort of entity (person, animal, place, material, manufactured material, etc). |
||||||||
| ObservationEffectiveTime |
Design Comments: This carries a range of time within which the observations occurred. |
||||||||
| value [1..1] (M) ParameterItem (QSET<TS>) |
Design Comments: The parameter value being sent with the query. In this case it will be GTS. This defines the time which relevant observations should be searched. |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: Provides a unique identification to a specific element in an identified response structure. In this case it is ObservationEvent.effectiveTime. |
||||||||
| ObservationStatusCode |
Design Comments: This is the status of the observation being queried. |
||||||||
| value [1..1] (M) ParameterItem (CV) {CNE:D:ActStatus} |
Design Comments: The parameter value being sent with the query. In this case it will be an ActStatusCode. |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: Provides a unique identification to a specific element in an identified response structure. In this case it is one of: ObservationReport.statusCode, ObservationBattery.statusCode, SpecimenObservationCluster.statusCode or ObservationEvent.statusCode. UsageNotes: ERROR - Business name from Visio is too long and was truncated. Full businessName follows. (ObservationReport.statusCode, ObservationBattery.statusCode, SpecimenObservationCluster.statusCode, ObservationEvent.statusCode |
||||||||
| ObservationType |
Design Comments: This carries an Observation type code as the parameter. |
||||||||
| value [1..1] (M) ParameterItem (CD) {CWE:D:ActCode} |
Design Comments: The parameter value being sent with the query. In this case it will be an ActCode (Observation Type). |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: Provides a unique identification to a specific element in an identified response structure. In this case it is one of: ObservationReport.code, ObservationBattery.code, SpecimenObservationCluster.code or ObservationEvent.code. UsageNotes: ERROR - Business name from Visio is too long and was truncated. Full businessName follows. (ObservationReport.code, ObservationBattery.code, ) (SpecimenObservationCluster.code, ObservationEvent.code |
||||||||
| PatientAdministrativeGender |
Design Comments: This carries a patient administrative gender parameter. |
||||||||
| value [1..1] (M) ParameterItem (CD) {CWE:D:AdministrativeGender} |
Design Comments: The parameter value being sent with the query. In this case it will be an administrative gender code. |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: Provides a unique identification to a specific element in an identified response structure. In this case it is Person.administrativeGenderCode. |
||||||||
| PatientDOB |
Design Comments: This carries a Patient date of birth parameter. |
||||||||
| value [1..1] (M) ParameterItem (IVL<TS>) |
Design Comments: The parameter value being sent with the query. In this case it will be a date of birth as an Interval of Timestamp (IVL<TS>). |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: Provides a unique identification to a specific element in an identified response structure. In this case it is Person.birthTime. |
||||||||
| PatientID |
Design Comments: A ParameterItem represents name, value pair which identifies a parameter and the value of the parameter to be used for a query. In this case the parameter is a set of Patient identifiers. |
||||||||
| value [1..*] (M) ParameterItem (DSET<II>) |
Design Comments: The parameter value being sent with the query. In this case it will be a Set of data type II (instance identifier data type). |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: Provides a unique identification to a specific element in an identified response structure. In this case it is Patient.id. |
||||||||
| PatientName |
Design Comments: This carries a patient name parameter. |
||||||||
| value [1..*] (M) ParameterItem (COLL<PN>) |
Design Comments: The parameter value being sent with the query. In this case it will be a Bag of PN (patient name data type). |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: Provides a unique identification to a specific element in an identified response structure. In this case it is Person.name. |
||||||||
| ProcessStepCode |
Design Comments: The means by which the act is carried out. For Specimen Collection, this is generally the collection method such as 'biopsy', 'fine needle aspiration', etc. |
||||||||
| value [1..1] (M) ParameterItem (CD) {CWE:D:x_LabProcessCodes} |
Design Comments: The means by which the act is carried out. For Specimen Collection, this is generally the collection method such as 'biopsy', 'fine needle aspiration', etc. |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: The means by which the act is carried out (ProcessStep.code). For Specimen Collection, this is generally the collection method such as 'biopsy', 'fine needle aspiration', etc. |
||||||||
| ProcessStepEffectiveTime |
Design Comments: Includes such events as: Specimen received in lab, Container registration, Specimen accession, Specimen treatment |
||||||||
| value [1..1] (M) ParameterItem (IVL<TS>) |
Design Comments: The effective time of SpecimenProcessStep that Includes such events as: Specimen received in lab, Container registration, Specimen accession, Specimen treatment |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: Specimen universal CMET Includes such events as: Specimen received in lab, Container registration, Specimen accession, Specimen treatment |
||||||||
| ProviderID |
Design Comments: This is the authoring provider for the observation. |
||||||||
| value [1..*] (M) ParameterItem (DSET<II>) |
Design Comments: The parameter value being sent with the query. In this case it will be identifiers for providers using a SET<II> (set of instance id's) as the data type. |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: Provides a unique identification to a specific element in an identified response structure. In this case its R_AssignedEntity.id. |
||||||||
| SortControl |
Design Comments: Holds specification of sort order for instance matches to a query. |
||||||||
| sequenceNumber [0..1] SortControl (INT.NONNEG) |
Design Comments: Provides the sequence or primacy of the various SortControls for a given query. |
||||||||
| elementName [0..1] SortControl (SC.NT) {CWE:D:ElementName} |
Design Comments: Identifies a RIM element in a query response upon which to sort. |
||||||||
| directionCode [0..1] SortControl (CS) {CNE:V:Sequencing} |
Design Comments: Specifies direction (ascending or descending) of the sort. |
||||||||
| SpecimenCollectionProcessEffectiveTime |
Design Comments: The time specimen was collected |
||||||||
| value [1..1] (M) ParameterItem (QSET<TS>) |
Design Comments: The clinically significant time for tests carried out on that specimen for the specimen collection process. |
||||||||
| semanticsText [0..1] ParameterItem (ST) |
Design Comments: Process.effectiveTime |
||||||||