A few proposed changes for the $find parameter data types

argonautproject / scheduling

Argonaut Scheduling and Appointments: This project supports basic patient and provider access to a provider's calendar and appointment requests, including APIs and guidance for searching and publishing a providers schedule andrequesting, cancelling or updating an appointment.

http://www.fhir.org/guides/argonaut/scheduling/

15 stars 2 forks source link

A few proposed changes for the $find parameter data types #36

Closed cooperthompson closed 6 years ago

cooperthompson commented 7 years ago

http://build.fhir.org/ig/argonautproject/scheduling/OperationDefinition-appointment-find-sprint.html

A few issues around data types:

The appt-type parameter is currently a string type. Shouldn't that be a coding data type? The provider parameter is currently a type uri. Shouldn't that be a reference data type?

brettmarquard commented 7 years ago

Do you have a suggested value set?

Healthedata1 commented 6 years ago

Rationale for types is to use simple parameter data types to allow using both GET and POST for Appointment$find:

Simple type ‘string’ instead of ‘Coding’ where the string type is same as token search parameter type
- Simple type ‘uri’ instead of Reference where the uri is same as reference search parameter

Healthedata1 commented 6 years ago

challenges for coding not sure of system - better if POST used coding.

Healthedata1 commented 6 years ago

OperationDefinition defines the search parameter type for strings. This is described in the documentation here?

This string parameter is interpreted as a Token search parameter. Each parameter value SHALL contain both the system property and the code property for a code using the general syntax specialty=[system]|[code]. See the examples below for how this is implemented.

Is this unclear or do we need to update the table to include a column for search parameter type?

brettmarquard commented 6 years ago

Does it state anywhere on the page why ' This string parameter is interpreted as a Token search parameter.'?

I think folks not involved will ask. I also think it's a good move to add search parameter type -- but I am not sure i like the idea of another column. Could we just add a note for the types that are string?

Healthedata1 commented 6 years ago

already in documentation. Suggestions to make it more obvious and clearer?

[image: Inline image 1]

Eric M Haas, DVM, MS Health eData Inc 211 South Jefferson Street, Napa, CA, 94559 707.227.2608|Skype: haas.eric1 ehaas@healthedatainc.com ehaas@healhtedatainc.com

On Thu, Sep 28, 2017 at 5:39 AM, brettmarquard notifications@github.com wrote:

Does it state anywhere on the page why ' This string parameter is interpreted as a Token search parameter.'?

I think folks not involved will ask. I also think it's a good move to add search parameter type -- but I am not sure i like the idea of another column. Could we just add a note for the types that are string?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/argonautproject/scheduling/issues/36#issuecomment-332823368, or mute the thread https://github.com/notifications/unsubscribe-auth/AHEU6hjaBPyOQmlcGjhgCTZq8Lsz8rJDks5sm5NmgaJpZM4PSYAz .

brettmarquard commented 6 years ago

Maybe something like – “FHIR allows a search parameter of type ‘string’ to be treated as different parameter types (e.g. number, date, reference, token). In this element, the string is to be interpreted as a Token search parameter.”

Healthedata1 commented 6 years ago

document and render string data search parameters types better. Gforge [#14092] for rendering

If unable to get IG-Pub updated then will update rendering in IG manually.

Healthedata1 commented 6 years ago

OK I updated the operation to document and render the search token. http://build.fhir.org/ig/argonautproject/scheduling/OperationDefinition-appointment-find.html

hope to close this one if this looks OK.