View source for Virtual Patient Track Proposal

[[Category:Virtual_FHIR_Connectathons]]
__NOTOC__
=Patient=
If creating a client, this track should require minimal work in advance of the connectathon, though at least a bit of playing is recommended.  If creating a server, advanced preparation will be required, but this scenario should somewhat limit the effort involved.

Pre-requisites: none

Step by step tutorial and sample projects: https://github.com/furore-fhir/fhirstarters

==Submitting WG/Project/Implementer Group==
FHIR Management Group (FMG) in association with Patient Care (PC)

==Justification==
<!--Why is this an important track to include in the connectathon - include implementer need, impact on ballot, FMM readiness of the resources, etc. -->
This is the Track 1 - Patient testing that is included in all FHIR Connectathons.

Its purpose is to provide a way for those new to FHIR to participate using a simple scenario that can be met with limited domain knowledge, and by those who have not have a lot of exposure to FHIR. It is quite feasible to complete the client side of the track within a day with only knowledge of a development environment - no previous FHIR knowledge.

While it can help the Patient resource progress along the Maturity Model, this is a secondary objective as the Patient resource has already had substantial exposure both at connectathons and in the wild.

==Proposed Track Lead==
<!-- Name, email and Skype id of individual who will coordinate the track at the connectathon -->

Jin Yang --  jin.yang@cambiahealth.com 
See [[Connectathon_Track_Lead_Responsibilities]]

==Expected participants==
<!-- List of the individuals and/or organizations that have indicated a desire to attend the connectathon and implement this track -->
Developers from the Payer User Group community.

==Roles==
<!-- Roles are sets of functionality (generally defined by a Conformance resource) that a single system can take on -->
===FHIR Client===
<!-- Provide a description of the capabilities this role will have within the connectathon -->
Enable the creation and retrieval of the Patient resource operations using the defined basic CRUD operations: create, history, read, search, update and delete.

===FHIR Server===
<!-- Provide a description of the capabilities this role will have within the connectathon -->
Support the receiving and processing of the Patient resource operations: create, history, read, search and update.

==Scenarios==
<!-- What will be the actions performed by participants? -->
=== 1. Register a new patient ===
:Action: (Patient Demographics consumer) creates a new patient and save to Patient Service. The client can assign the Id.
:Precondition: Patient does not exist in service prior to action
:Success Criteria: Patient created correctly on server (use browser to inspect Patient)
:Bonus point: The Patient resource has an extension

>>Note: the resource Id can either be created by the client or the server (depending on the capability of the server). However, if the server assigns the Id, then the client will need to be able to retrieve the Id from the server response or by a patient query.

=== 2. Update a patient ===
:Action: (Patient Demographics consumer) updates the patient created in scenario #1 and updates to Patient Service. The patient is retrieved by Id.
:Precondition: Patient has been created
:Success Criteria: Patient updated on server (use browser to inspect Patient)
:Bonus Point #1: Update a patient that has extensions, but leaving the extension untouched.
:Bonus Point #2: Update a patient that has extensions, and update the extension also.

=== 3. Retrieve Patient history ===
:Action: (Patient Demographics consumer) searches the patient Service for the history of a Patient
:Precondition:  There is a patient that has at least one update
:Success Criteria: Patient's history displayed in interface. (use browser query Patient Service)
:Bonus point: The UI allows the user to display previous versions of the Patient

=== 4. Search for a patient on name ===
:Action: (Patient Demographics consumer) searches the patient Service for patients with a given name
:Precondition: Patients with that name have  been created
:Success Criteria: patients displayed in interface. (use browser query to confirm)

=== 5. Delete a patient  ===
:Action: (Patient Demographics consumer) deletes the patient with a given id
:Precondition: a Patients with that Id has  been created
:Success Criteria: Subsequently querying for the patient - either searching by name or by Id - fails.

==Help Links==
Here are some links to assist implementers:

* [http://hl7.org/fhir/http.html/ REST API in the Spefication].
* [http://hl7.org/fhir/patient.html/ Patient resource in the Spefication].
* [http://fhirblog.com/2014/07/31/fhir-connectathon-7-for-java-dummies/ Java client sample].
* [http://fhirblog.com/2014/06/29/c-fhir-client/ .net client sample].
* [http://wiki.hl7.org/index.php?title=Publicly_Available_FHIR_Servers_for_testing Publicly Available FHIR Servers for testing].

[http://www.example.com link title]==TestScript(s)==
<!-- Optional (for initial proposal): Provide links to the TestScript instance(s) that define the behavior to be tested-->
The supporting TestScripts and corresponding fixtures have been committed to the FHIR SVN repository at:
http://gforge.hl7.org/svn/fhir/trunk/connectathons/MontrealMay2016/Connectathon12/Track-13-Patient

===TestScript Definitions===
The TestScript resources in this folder represent all of the possible variations** within the tests; i.e. JSON vs. XML content, client vs. server resource id assignment, and bonus vs. no bonus features.

''**This representation of the Track 1 - Patient tests is not meant to be definitive and complete. This is one example of how these tests can be defined in the current STU 3 Candidate format of the TestScript resource. Constructive feedback, suggestions and criticisms are welcome.''

Based on these testing variations, the following TestScript definitions are available - one for each variation:

====FHIR Resource ID Assigned by the Client====

•	[http://gforge.hl7.org/gf/project/fhir/scmsvn/?action=browse&path=%2F%2Acheckout%2A%2Ftrunk%2Fconnectathons%2FMontrealMay2016%2FConnectathon12%2FTrack-13-Patient%2FClient%2520Assigned%2520Id%2Fconnectathon-12-track-13-patient-base-client-id-json.xml&content-type=text%2Fplain connectathon-12-track-13-patient-base-client-id-json] -- JSON Format - Baseline tests to create, update, retrieve history and search a patient, no extensions with client assigned resource id.
 
•	[http://gforge.hl7.org/gf/project/fhir/scmsvn/?action=browse&path=%2F%2Acheckout%2A%2Ftrunk%2Fconnectathons%2FMontrealMay2016%2FConnectathon12%2FTrack-13-Patient%2FClient%2520Assigned%2520Id%2Fconnectathon-12-track-13-patient-base-client-id-xml.xml&content-type=text%2Fplain connectathon-12-track-13-patient-base-client-id-xml] -- XML Format - Baseline tests to create, update, retrieve history and search a patient, no extensions with client assigned resource id. 

•	[http://gforge.hl7.org/gf/project/fhir/scmsvn/?action=browse&path=%2F%2Acheckout%2A%2Ftrunk%2Fconnectathons%2FMontrealMay2016%2FConnectathon12%2FTrack-13-Patient%2FClient%2520Assigned%2520Id%2Fconnectathon-12-track-13-patient-bonus-client-id-json.xml&content-type=text%2Fplain connectathon-12-track-13-patient-bonus-client-id-json] -- JSON Format - Baseline (Bonus) tests to create, update, retrieve history and search a patient, with extensions and client assigned resource id. 

•	[http://gforge.hl7.org/gf/project/fhir/scmsvn/?action=browse&path=%2F%2Acheckout%2A%2Ftrunk%2Fconnectathons%2FMontrealMay2016%2FConnectathon12%2FTrack-13-Patient%2FClient%2520Assigned%2520Id%2Fconnectathon-12-track-13-patient-bonus-client-id-xml.xml&content-type=text%2Fplain connectathon-12-track-13-patient-bonus-client-id-xml] -- XML Format - Baseline (Bonus) tests to create, update, retrieve history and search a patient, with extensions and client assigned resource id.

====FHIR Resource ID Assigned by the Server====

•	[http://gforge.hl7.org/gf/project/fhir/scmsvn/?action=browse&path=%2F%2Acheckout%2A%2Ftrunk%2Fconnectathons%2FMontrealMay2016%2FConnectathon12%2FTrack-13-Patient%2FServer%2520Assigned%2520Id%2Fconnectathon-12-track-13-patient-base-server-id-json.xml&content-type=text%2Fplain connectathon-12-track-13-patient-base-server-id-json] -- JSON Format - Baseline tests to create, update, retrieve history and search a patient, no extensions with server assigned resource id. 

•	[http://gforge.hl7.org/gf/project/fhir/scmsvn/?action=browse&path=%2F%2Acheckout%2A%2Ftrunk%2Fconnectathons%2FMontrealMay2016%2FConnectathon12%2FTrack-13-Patient%2FServer%2520Assigned%2520Id%2Fconnectathon-12-track-13-patient-base-server-id-xml.xml&content-type=text%2Fplain connectathon-12-track-13-patient-base-server-id-xml] -- XML Format - Baseline tests to create, update, retrieve history and search a patient, no extensions with server assigned resource id. 

•	[http://gforge.hl7.org/gf/project/fhir/scmsvn/?action=browse&path=%2F%2Acheckout%2A%2Ftrunk%2Fconnectathons%2FMontrealMay2016%2FConnectathon12%2FTrack-13-Patient%2FServer%2520Assigned%2520Id%2Fconnectathon-12-track-13-patient-bonus-server-id-json.xml&content-type=text%2Fplain connectathon-12-track-13-patient-bonus-server-id-json] -- JSON Format - Baseline (Bonus) tests to create, update, retrieve history and search a patient, with extensions and server assigned resource id. 

•	[http://gforge.hl7.org/gf/project/fhir/scmsvn/?action=browse&path=%2F%2Acheckout%2A%2Ftrunk%2Fconnectathons%2FMontrealMay2016%2FConnectathon12%2FTrack-13-Patient%2FServer%2520Assigned%2520Id%2Fconnectathon-12-track-13-patient-bonus-server-id-xml.xml&content-type=text%2Fplain connectathon-12-track-13-patient-bonus-server-id-xml] -- XML Format - Baseline (Bonus) tests to create, update, retrieve history and search a patient, with extensions and server assigned resource id.

===Conventions Used===
The execution of the TestScript resources contained in this folder are constrained by the following conventions:

'''Fixtures''' - All resource reference values can be either url paths or local local file system paths. The convention for these TestScript resources use local file system paths where the execution engine is expected to resolve this path based on the following:
* Leading '/' character - this is resolved as an absolute path based on a known root path.
* No leading '/' character - this is resolved as a relative path based on the location of the TestScript resource file.