Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the Quick Start Documentation #335

Open
c-schuler opened this issue May 8, 2023 · 10 comments
Open

Update the Quick Start Documentation #335

c-schuler opened this issue May 8, 2023 · 10 comments
Assignees
Labels
2 2 Sprint Points documentation Improvements or additions to documentation enhancement New feature or request

Comments

@c-schuler
Copy link
Collaborator

c-schuler commented May 8, 2023

This purpose of this task is to walk through the Quick Start guide in the IG and update links, content (artifacts, request/response, etc) and workflows. This issue is relevant for both the master (2022) and 2016 branches.

Pull request 2022: #336
Pull request 2016: #337

@c-schuler c-schuler added documentation Improvements or additions to documentation enhancement New feature or request 2 2 Sprint Points labels May 8, 2023
@alackerbauer
Copy link
Contributor

alackerbauer commented May 11, 2023

@1anja1
Copy link
Collaborator

1anja1 commented May 11, 2023

@1anja1
Copy link
Collaborator

1anja1 commented May 11, 2023

For me the CDS sandbox worked up until the point where it cannot find the patient
Screenshot 2023-05-11 at 13 27 52

The patient exists though:
Screenshot 2023-05-11 at 13 35 40

@1anja1
Copy link
Collaborator

1anja1 commented May 11, 2023

I updated the 2022 quick start guide with all changes except the links to the bundles - (responses need to be checked once the correct bundles are available)
The changes can be found in this branch: #335-update-quick-start-documentation

@alackerbauer
Copy link
Contributor

alackerbauer commented May 11, 2023

@1anja1 the thing you describe about not being able to switch the patient might be an actual bug in the sandbox. All GET requests go through and are successful (status code 200) - just the JS code has some problem since it is expecting something else in the bundle, and/or our setup for this scenario is not properly providing everything that is expected: of note, the conditions of our patients are empty, or better said: there is no single condition on the server.

--> solved by making sure the patient has a name element (see comment below)

@alackerbauer
Copy link
Contributor

alackerbauer commented May 12, 2023

do you have any idea where the quickstart-medications-bundle could be found? i searched through different tags but also in older versions it seems to not be existent.

can't find that bundle, created a new bundle with the MedicationRequest resources originating from this bundle: request for the rec 10 patient view.

@1anja1
Copy link
Collaborator

1anja1 commented May 20, 2023

all bundles and links in the 2022 version are now updated (on the branch for this ticket), however, when executing all the statements as described in the guide the cards response does not contain the suggestions element like it was shown in the old version of the quickstart guide
Current:
Screenshot 2023-05-20 at 12 17 47
Old version:
Screenshot 2023-05-20 at 12 18 11

@alackerbauer
Copy link
Contributor

alackerbauer commented May 23, 2023

@1anja1 I went through the new guide and it is looking good in general. some things I have discovered:

  • cds sandbox: the patient switching only works when our sample patient has a name element. if you experience the same behaviour, we should add such element to the quickstart sample patient
  • in the last part, for testing the service in the cds sandbox, the ID in the URL of the PUT request is different from the ID element in the Patient resource. they need to be the same ID
  • I experience the same issue with no suggestions showing in the response cards, which I believe is not expected behavior. we will ask for some clarification on what the expected behaviour is and where the problems are. --> see comment below

@1anja1
Copy link
Collaborator

1anja1 commented May 24, 2023

all bundles and links in the 2022 version are now updated (on the branch for this ticket), however, when executing all the statements as described in the guide the cards response does not contain the suggestions element like it was shown in the old version of the quickstart guide
Current:
Screenshot 2023-05-20 at 12 17 47
Old version:
Screenshot 2023-05-20 at 12 18 11

The card we are getting might actually be the expected behaviour. It is the same as the response in this File: https://github.com/cqframework/opioid-cds-r4/blob/31916c12adeaf2f3dece330910e0f06d896340e5/input/pagecontent/responses/OpioidCDSREC10PatientView/response-example-rec-10-patient-view-no-screenings.json

@alackerbauer
Copy link
Contributor

finished 2016 including comments of last stand up meeting. still need to pull in changes for 2022.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 2 Sprint Points documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants