Parameter required, this value is passed – careProvisionCode to the pcgm helper function by the careProvisionReason Not used by PCGM careRecordTimePeriod Not used by PCGM clinicalStatementTimePeriod Not used by PCGM maximumHistoryStatements Not used by PCGM patientAdministrativeGender Not used by PCGM patientBirthTime Not used by PCGM Parameter required, this is passed to – patientId the pcgm helper function by the patientName Not used by PCGM Table : Child Elements of QueryByParameterPayload Element Element Value Source Plugin helper function creates a timestamp for message instance that may be used as the query identifier queryId OR Plugin helper function creates a unique identifier for message instance that may be used as the query identifier Plugin configuration file contains the code specific for default statusCode the message type Not required not used, however a default value may be – responseModalityCode added to the plugin configuration file Plugin configuration file contains the code specific for default responsePriorityCode the message type careEventId Not used by PCGM Parameter optional, plugin configuration file contains – encounterStatus default encounterTimeFrame Not used by PCGM Parameter required, this value is passed to the pcgm – patientId helper function by the user-developer patientLocationId Not used by PCGM responsibleOrganization Not used by PCGM Parameter optional, plugin configuration file contains – typeOfEncounter default Both and contain optional elements listed in the tables above. These queryByParameter queryByParameterPayload elements are used to constrain the query search. PCGM only uses the minimal constraint on the request search and only asks the user-developer to provide those values as parameters. This allows the user-developer to quickly query the underlying EHR with minimal information. Then once results are returned determine if further constrains are necessary for a given use case. Any further filtering of the returned data can be done locally.
careProvisionCode Parameter – required, this value is passed to the pcgm helper function by the careProvisionReason Not used by PCGM careRecordTimePeriod Not used by PCGM clinicalStatementTimePeriod Not used by PCGM maximumHistoryStatements Not used by PCGM patientAdministrativeGender Not used by PCGM patientBirthTime Not used by PCGM patientId Parameter – required, this is passed to the pcgm helper function by the patientName Not used by PCGM Table : Child Elements of QueryByParameterPayload Element Element Value Source queryId Plugin helper function creates a timestamp for message instance that may be used as the query identifier OR Plugin helper function creates a unique identifier for message instance that may be used as the query identifier statusCode Plugin configuration file contains the default code specific for the message type responseModalityCode Not required – not used, however a default value may be added to the plugin configuration file responsePriorityCode Plugin configuration file contains the default code specific for the message type careEventId Not used by PCGM encounterStatus Parameter – optional, plugin configuration file contains default encounterTimeFrame Not used by PCGM patientId Parameter – required, this value is passed to the pcgm helper function by the user-developer patientLocationId Not used by PCGM responsibleOrganization Not used by PCGM typeOfEncounter Parameter – optional, plugin configuration file contains default Both queryByParameter and queryByParameterPayload contain optional elements listed in the tables above. These elements are used to constrain the query search. PCGM only uses the minimal constraint on the request search and only asks the user-developer to provide those values as parameters. This allows the user-developer to quickly query the underlying EHR with minimal information. Then once results are returned determine if further constrains are necessary for a given use case. Any further filtering of the returned data can be done locally.
PCGM_SDD_v1.0_MSWORD.docx