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

[Requirements] Add support to reference use cases #681

Closed
schnuerle opened this issue Aug 13, 2021 · 3 comments · Fixed by #813
Closed

[Requirements] Add support to reference use cases #681

schnuerle opened this issue Aug 13, 2021 · 3 comments · Fixed by #813
Labels
Policy Specific to the Policy API Requirements Directly related to features in the Policy Requirements endpoint
Milestone

Comments

@schnuerle
Copy link
Member

schnuerle commented Aug 13, 2021

With the new Policy program Requirements endpoint there is an opportunity to align agency data sharing requirements and operating programs with externally specified use cases.

Describe the solution you'd like

An array of use case ids could be added for each program, with a name , info link, and database link to the use case database that is being referenced. For example, the 'OMF Use Cases' could be referenced by this info link and this database link, and IDs like 'OMF-1', 'OMF-10' could be added to the database so each use case could be referenced.

Cities could create their own use case list, or refer to use cases created by providers, or by non-profits, or by any other data standards organizations.

Is this a breaking change

  • I'm not sure

Impacted Spec

For which spec is this feature being requested?

  • policy

Describe alternatives you've considered

N/A

Additional context

Referring to use cases can help agencies communicate their needs for MDS data more clearly, and can help where there is a legal or procedural need to articulate use cases, like GDPR in Europe.

REMOVED: Amsterdam's draft standard CDS-M has a 'city-license' file that it much like Requirements, and there is a section with an array of use case IDs called useCasesCovered.

NEW: https://github.com/CDSM-WG/CDS-M/tree/main/use-cases folders with use cases with a referenceable 'id' field like "id": "ratio-offer-demand",.

@schnuerle schnuerle added the Policy Specific to the Policy API label Aug 13, 2021
@schnuerle schnuerle added this to the 2.0.0 milestone Aug 13, 2021
@schnuerle schnuerle added the Requirements Directly related to features in the Policy Requirements endpoint label Apr 1, 2022
@schnuerle
Copy link
Member Author

We now have an ID column on our use case database that can be referenced in the format 'OMF-MDS-##'.

@schnuerle
Copy link
Member Author

@schnuerle schnuerle linked a pull request Dec 19, 2022 that will close this issue
@schnuerle
Copy link
Member Author

Resolved with #813

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Policy Specific to the Policy API Requirements Directly related to features in the Policy Requirements endpoint
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant