| PRPA_MT202306UV02 Location Registry Query By Details |
Derived from RMIM: PRPA_RM202306UV02 and HMD: PRPA_HD202306UV02 |
||||||||
| QueryByParameter |
Design Comments: Entry point for the Query By Location Details 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 [0..1] 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 |
||||||||
| executionAndDeliveryTime [0..1] QueryByParameter (TS) |
Design Comments: Specifies the time the response is to be returned |
||||||||
| matchCriterionList [0..1] (MatchCriterionList) |
Design Comments: This collection of parameter items convey instructions to the query fulfiller. The associated parameter items are joined with OR logic. |
||||||||
| parameterList [1..1] (ParameterList) | |||||||||
| sortControl [0..*] (SortControl) |
Design Comments: This class allows the query requester to specify the order in which the server should return multiple results |
||||||||
| MatchCriterionList |
Design Comments: This collection of parameter items convey instructions to the query fulfiller. The associated parameter items are joined with OR logic. |
||||||||
| id [0..1] ParameterList (II) |
|||||||||
| matchAlgorithm [0..1] (MatchAlgorithm) |
Design Comments: This parameter conveys instructions to the query fulfiller specifying the preferred matching algorithm to use |
||||||||
| matchWeight [0..1] (MatchWeight) |
Design Comments: This parameter conveys instructions to the query fulfiller specifying the desired weight to be assigned to parameter types in the matching process |
||||||||
| minimumDegreeMatch [0..1] (MinimumDegreeMatch) |
Design Comments: This parameter conveys instructions to the query fulfiller specifying the minimum degree of match to use in filtering results |
||||||||
| MatchAlgorithm |
Design Comments: This parameter conveys instructions to the query fulfiller specifying the preferred matching algorithm to use |
||||||||
| value [1..1] ParameterItem (ANY) {CWE:D:QueryParameterValue} |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "MatchAlgorithm"} |
|||||||||
| MatchWeight |
Design Comments: This parameter conveys instructions to the query fulfiller specifying the desired weight to be assigned to parameter types in the matching process |
||||||||
| value [1..1] ParameterItem (ANY) {CWE:D:QueryParameterValue} |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "MatchWeight"} |
|||||||||
| MinimumDegreeMatch |
Design Comments: This parameter conveys instructions to the query fulfiller specifying the minimum degree of match to use in filtering results |
||||||||
| value [1..1] (M) ParameterItem (ANY) {CWE:D:QueryParameterValue} |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "MinimumDegreeMatch"} |
|||||||||
| ParameterList | |||||||||
| identifiedLocationId [0..*] (IdentifiedLocationId) |
Design Comments: This query parameter is an identifier used for a service delivery location by an organization. The organization's name would be sent in an IdentifyingOrg parameter. |
||||||||
| identifyingOrg [0..*] (IdentifyingOrg) |
Design Comments: This query parameter is the name of an organization that has assigned its own identifier to a service delivery location. The identifier would be sent in an IdentifyingOrgId parameter. |
||||||||
| sdlocAddress [0..*] (SdlocAddress) |
Design Comments: This query parameter is the postal address of a service delivery location |
||||||||
| sdlocName [0..*] (SdlocName) |
Design Comments: This query parameter is the name of a service delivery location |
||||||||
| sdlocService [0..*] (SdlocService) |
Design Comments: This query parameter is a code drawn from the ActServiceDeliveryLocationService domain that defines a type of service that can be performed at a service delivery location |
||||||||
| sdlocStatus [0..*] (SdlocStatus) |
Design Comments: This query parameter is the status of a record in the target service delivery location registry. It is used to find records in a particular state such as "active" or "completed". |
||||||||
| sdlocTerritorialAuthority [0..*] (SdlocTerritorialAuthority) |
Design Comments: This query parameter is the identifier of a territorial authority that has jurisdiction over a service delivery location |
||||||||
| sdlocType [0..*] (SdlocType) |
Design Comments: This query parameter is value from the ServiceDeliveryLocationRoleType domain that classifies the setting where services may be delivered. Examples include, hospital, chronic care facility,allergy clinic, ambulance. |
||||||||
| IdentifiedLocationId |
Design Comments: This query parameter is an identifier used for a service delivery location by an organization. The organization's name would be sent in an IdentifyingOrg parameter. |
||||||||
| value [1..*] ParameterItem (DSET<II>) |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "ServiceDeliveryLocation.indirectAuthority.IdentifiedLocation.id"} |
|||||||||
| IdentifyingOrg |
Design Comments: This query parameter is the name of an organization that has assigned its own identifier to a service delivery location. The identifier would be sent in an IdentifyingOrgId parameter. |
||||||||
| value [1..*] ParameterItem (DSET<ON>) |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "IdentifiedLocation.assigningIdentifierOrganization.name"} |
|||||||||
| SdlocAddress |
Design Comments: This query parameter is the postal address of a service delivery location |
||||||||
| value [1..*] ParameterItem (DSET<AD>) |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "ServiceDeliveryLocation.addr"} |
|||||||||
| SdlocName |
Design Comments: This query parameter is the name of a service delivery location |
||||||||
| value [1..*] ParameterItem (DSET<EN>) |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "ServiceDeliveryLocation.name"} |
|||||||||
| SdlocService |
Design Comments: This query parameter is a code drawn from the ActServiceDeliveryLocationService domain that defines a type of service that can be performed at a service delivery location |
||||||||
| value [1..*] ParameterItem (DSET<CD>) {CWE:D:ActCode} |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "ServiceDeliveryLocation.locationOf.ServiceDefinition.code"} |
|||||||||
| SdlocStatus |
Design Comments: This query parameter is the status of a record in the target service delivery location registry. It is used to find records in a particular state such as "active" or "completed". |
||||||||
| value [1..1] ParameterItem (CV) {CWE:D:RoleStatus} |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "ServiceDeliveryLocation.statusCode"} |
|||||||||
| SdlocTerritorialAuthority |
Design Comments: This query parameter is the identifier of a territorial authority that has jurisdiction over a service delivery location |
||||||||
| value [1..*] ParameterItem (DSET<II>) |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "ServiceDeliveryLocation.indirectAuthority.TerritorialAuthority.id"} |
|||||||||
| SdlocType |
Design Comments: This query parameter is value from the ServiceDeliveryLocationRoleType domain that classifies the setting where services may be delivered. Examples include, hospital, chronic care facility,allergy clinic, ambulance. |
||||||||
| value [1..*] ParameterItem (DSET<CD>) {CWE:D:RoleCode} |
|||||||||
| semanticsText [1..1] ParameterItem (ST){default= "ServiceDeliveryLocation.code"} |
|||||||||
| 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) |
||||||||