profile
'flow-results-package'
flow_results_specification_version
'1.0.0-rc1'
created
'2017-06-30 15:35:27+00:00'
modified
'2017-06-30 15:38:05+00:00'
id
"b03ec84-77fd-4270-813b-0c698943f7ce"
name
"flow-results-demo-package"
title
"March 2017 Malaria Protection Survey"
path
or api_data_url
must be provided for the Resource.access_method
of the Resource is an optional parameter, and can be either api
or file
:access_method
is file
, it indicates all responses are available in a static JSON file. (The default if this parameter is not provided is file
.) When data is available via file semantics, the Resource path
shall be a file reference or URL for the complete response data.access_method
is api
, it indicates the resource can be queried using the API Usage specification, with support for pagination and filtering. The Resource api_data_url
must be provided with the Responses URL on the API server.schema
property of the resource must be provided inline, and must not use an external schema file or URL.schema
property must contain a fields
object describing the 6 columns within the Resource data. These fields are common to all Flow Results Packages, but are provided here for compatibility with software designed to dynamically read Tabular Data Resources:schema
property must additionally contain a questions
object describing metadata for all the Questions pertaining to Responses in this package. The object identifier (e.g.: 'ae54d3') of questions in this object connects to the Question ID found in each Response row:type
'type':'multiple_choice_one'
label
'label':'Are you male or female?'
type_options
type_options
are listed below under Question Types.'choices':['male', 'female']
semantic_labels
(optional, array of strings)"semantic_labels": ["SNOMEDCT::365873007"]
is_personal_information
(optional, boolean)"is_personal_information": true
set_contact_property
(optional, string)"set_contact_property": "gender"
set_group_membership
(optional, string)"set_group_membership": "farmers"
schema
property may optionally contain a language
property. If provided, this must be in the form of ISO 639-3, describing the language of the labels in the questions
object. Localization of these labels is left outside the scope of the Flow Results specification.path
file (or the api_data_url
endpoint) must provide the Response data in JSON "row array" format, as shown in the following example:2017-05-23T13:35:37.291-04:00
20394823948
'6085f5f2-80a2-423a-9f66-be3b3d777eea'
923842093
'43979e6c-6b59-4ccf-a260-4361ebbc3264'
10499221
'ae54d3'
'female'
{'choice_order': ['male', 'female'] }
id
; each change to a flow creates a new packageid
. The implementation would serve separate results for different package id
s. Client software or external services could examine the Descriptor of each Package and determine, with additional user information, how to aggregate the responses together.id
; changes to a flow create new versions under the same id
id
, according to the following constraints. Specifically, newer versions of the same package id
may add additional questions
within the schema; however, questions may not be removed, and the metadata for existing questions may not be changed. This implies that if a newer version of a flow removes a question from a previous version, the old question will continue to be listed in the schema for the new version. (This ensures that the schema of the most recent version contains a complete set of questions describing all responses in the aggregated resource data, including responses collected under older verions.) The modified
timestamp is used as a version control indicator for the Package.min-version
and max-version
to allow clients to selectively retrieve responses from specific versions. (If a client has cached a version of the schema from a Package descriptor, it is recommended to supply the Package's modified
descriptor as the max-version
when querying the API for responses, to ensure it does not receive responses from newer versions without a corresponding question
in the cached schema.)id
s are required; external clients are responsible for more advanced forms of aggregation across versions of flows.schema
metadata, and within the Response Metadata for each row:SENT
(dispatched to delivery service), DELIVERED
(received on the device), CONSUMED
(read or listened to by the recipient), SEND_FAILED
(failure at sending), or DELIVERY_FAILED
(failure at delivery)choices
.choices
:type
is identified within the response metadata.)schema
level. (Refer to the type_options
within each row.)[lat, long]
[lat, long, elevation]
[lat, long, elevation, accuracy]
date-time
format with timezone extension: