Merge pull request #417 from cds-hooks/iss278-add-puncuation-to-table-descriptions

updated punctuation in tables

Author: brettmarquard

docs/specification/1.0.md

@@ -44,23 +44,23 @@ The response to the discovery endpoint SHALL be an object containing a list of C
 
 Field | Description
 ----- | ---------
-`services` | *array*. An array of **CDS Services**
+`services` | *array*. An array of **CDS Services**.
 
 Each CDS Service SHALL be described by the following attributes.
 
 Field | Optionality | Type | Description
 ----- | ----- | ----- | ---------
 `hook`| REQUIRED | *string* | The hook this service should be invoked on. See [Hooks](../hooks/index.md).
-`title`| RECOMMENDED | *string* | The human-friendly name of this service
-<nobr>`description`</nobr>| REQUIRED | *string* | The description of this service
+`title`| RECOMMENDED | *string* | The human-friendly name of this service.
+<nobr>`description`</nobr>| REQUIRED | *string* | The description of this service.
 `id` | REQUIRED | *string* | The {id} portion of the URL to this service which is available at<br />`{baseUrl}/cds-services/{id}`
 `prefetch` | OPTIONAL | *object* | An object containing key/value pairs of FHIR queries that this service is requesting that the EHR prefetch and provide on each service call. The key is a *string* that describes the type of data being requested and the value is a *string* representing the FHIR query.<br />See [Prefetch Template](#prefetch-template).
 
 ### HTTP Status Codes
 
 Code | Description
 ---- | -----------
-`200 OK` | A successful response
+`200 OK` | A successful response.
 
 CDS Services MAY return other HTTP statuses, specifically 4xx and 5xx HTTP error codes.
 
@@ -108,12 +108,12 @@ An EHR SHALL call a CDS Service by `POST`ing a JSON document to the service as d
 Field | Optionality | Type | Description
 ----- | ----- | ----- | --------
 `hook` | REQUIRED | *string* | The hook that triggered this CDS Service call. See [Hooks](../hooks/index.md).
-<nobr>`hookInstance`</nobr> | REQUIRED | *string* | A UUID for this particular hook call (see more information below)
+<nobr>`hookInstance`</nobr> | REQUIRED | *string* | A UUID for this particular hook call (see more information below).
 `fhirServer` | OPTIONAL | *URL* | The base URL EHR's [FHIR](https://www.hl7.org/fhir/) server. If fhirAuthorization is provided, this field is REQUIRED.  The scheme should be `https`
 `fhirAuthorization` | OPTIONAL | *object* | A structure holding an [OAuth 2.0][OAuth 2.0] bearer access token granting the CDS Service access to FHIR resources, along with supplemental information relating to the token. See the [FHIR Resource Access](#fhir-resource-access) section for more information.
 `user` | REQUIRED | *string* | The FHIR resource type + id representing the current user.<br />The type is one of: [Practitioner](https://www.hl7.org/fhir/practitioner.html), [Patient](https://www.hl7.org/fhir/patient.html), or [RelatedPerson](https://www.hl7.org/fhir/relatedperson.html).<br />For example, `Practitioner/123`
 `context` | REQUIRED | *object* | Hook-specific contextual data that the CDS service will need.<br />For example, with the `patient-view` hook this will include the FHIR identifier of the [Patient](https://www.hl7.org/fhir/patient.html) being viewed.  For details, see the Hooks specification page.
-`prefetch` | OPTIONAL | *object* | The FHIR data that was prefetched by the EHR (see more information below)
+`prefetch` | OPTIONAL | *object* | The FHIR data that was prefetched by the EHR (see more information below).
 
 #### hookInstance
 
@@ -182,7 +182,7 @@ The CDS Hooks specification defines just one prefetch token:
 
 |Variable|Meaning|
 ---------|--------
-|`{{user}}`|The value of the `user` field from this CDS Service request (e.g. `Practitioner/123`)|
+|`{{user}}`|The value of the `user` field from this CDS Service request (e.g. `Practitioner/123`).|
 
 Individual hooks specify which of their `context` fields can be used as prefetch tokens. Only root-level fields with a primitive value within the `context` object are eligible to be used as prefetch tokens.
 
@@ -234,9 +234,9 @@ goal is to know, at call time:
 
 | Key | Description |
 | --- | ----------- |
-| `p` | Patient demographics |
-| `a1c` | Most recent Hemoglobin A1c reading for this patient |
-| `u` | Information on the current user (Practitioner)
+| `p` | Patient demographics. |
+| `a1c` | Most recent Hemoglobin A1c reading for this patient. |
+| `u` | Information on the current user (Practitioner).
 
 #### Example prefetch response
 
@@ -305,7 +305,7 @@ The access token is specified in the CDS Service request via the OPTIONAL `fhirA
 Field | Optionality | Type | Description
 ----- | ----- | ----- | -----------
 `access_token` | REQUIRED | *string* | This is the [OAuth 2.0][OAuth 2.0] access token that provides access to the FHIR server.
-`token_type`   | REQUIRED | *string* | Fixed value: `Bearer`.
+`token_type`   | REQUIRED | *string* | Fixed value: `Bearer`
 `expires_in`   | REQUIRED | *integer* | The lifetime in seconds of the access token.
 `scope`        | REQUIRED | *string* | The scopes the access token grants the CDS Service.
 `subject` | REQUIRED | *string* | The [OAuth 2.0][OAuth 2.0] client identifier of the CDS Service, as registered with the EHR's authorization server.
@@ -353,7 +353,7 @@ Each **Card** is described by the following attributes.
 Field | Optionality | Type | Description
 ----- | ----- | ----- | --------
 `summary` | REQUIRED | *string* | One-sentence, <140-character summary message for display to the user inside of this card.
-`detail` | OPTIONAL | *string* | Optional detailed information to display; if provided MUST be represented in [(GitHub Flavored) Markdown](https://github.github.com/gfm/). (For non-urgent cards, the EHR MAY hide these details until the user clicks a link like "view more details...".)
+`detail` | OPTIONAL | *string* | Optional detailed information to display; if provided MUST be represented in [(GitHub Flavored) Markdown](https://github.github.com/gfm/). (For non-urgent cards, the EHR MAY hide these details until the user clicks a link like "view more details...").
 `indicator` | REQUIRED | *string* | Urgency/importance of what this card conveys. Allowed values, in order of increasing urgency, are: `info`, `warning`, `critical`. The EHR MAY use this field to help make UI display decisions such as sort order or coloring.
 `source` | REQUIRED | *object* | Grouping structure for the **Source** of the information displayed on this card. The source should be the primary source of guidance for the decision support the card represents.
 <nobr>`suggestions`</nobr> | OPTIONAL | *array* of **Suggestions** | Allows a service to suggest a set of changes in the context of the current activity (e.g.  changing the dose of the medication currently being prescribed, for the `medication-prescribe` activity). If used, the user MUST be allowed to choose no more than one suggestion.
@@ -490,7 +490,7 @@ Field | Optionality | Type | Value
 ----- | ----- | ----- | --------
 alg | REQUIRED | *string* | The cryptographic algorithm used to sign this JWT.
 kid | REQUIRED | *string* | The identifier of the key-pair used to sign this JWT. This identifier MUST be unique within the EHR's JWK Set.
-typ | REQUIRED | *string* | Fixed value: `JWT`.
+typ | REQUIRED | *string* | Fixed value: `JWT`
 jku | OPTIONAL | *url*    | The URL to the JWK Set containing the public key(s).
 
 The JWT payload contains the following fields:
@@ -501,7 +501,7 @@ iss | REQUIRED | *string* | The URI of the issuer of this JWT.  Note that the JW
 aud | REQUIRED | *string* or *array of string* | The CDS Service endpoint that is being called by the EHR. (See more details below).
 exp | REQUIRED | *number* | Expiration time integer for this authentication JWT, expressed in seconds since the "Epoch" (1970-01-01T00:00:00Z UTC).
 iat | REQUIRED | *number* | The time at which this JWT was issued, expressed in seconds since the "Epoch" (1970-01-01T00:00:00Z UTC).
-jti | REQUIRED | *string* | A nonce string value that uniquely identifies this authentication JWT (used to protect against replay attacks)
+jti | REQUIRED | *string* | A nonce string value that uniquely identifies this authentication JWT (used to protect against replay attacks).
 
 CDS Services SHOULD whitelist the `iss`, `jku` and `sub` fields to only the EHRs they trust.