Skip to main content
API docs by Redocly

Delivery Service (1.0)

Healthwise Content Delivery Service

Content

Retrieve specific content by ID.

Authorizations:
token
path Parameters
contentId
required
string^[a-zA-Z0-9-]+$
Example: aci8886

ID of content to retrieve.

query Parameters
Retrieve
string
Example: Retrieve=title

A comma-delimited list of the data of the content to retrieve. The content ID and localization will always be returned. Valid options: ages, audience, coreSets, codes, concepts, type, keywords, renditionLocalizations, title. A wildcard (*) may be passed to retrieve all data.

header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Response samples

Content type
application/json
{
  • "links": [
    ],
  • "hits": [
    ],
  • "top": 0,
  • "skip": 0,
  • "numberOfHits": 0
}

Retrieve all content for a specified core content set and aspect.

Authorizations:
token
path Parameters
coreSetId
required
string^[cC]{2}_\d+$
Example: CC_00001

Specify the core content set from the Healthwise core content set library.

aspect
required
string
Example: whatIs

Specify the aspect for the core content set.

query Parameters
Retrieve
string
Example: Retrieve=title

A comma-delimited list of the data of the content to retrieve. The content ID and localization will always be returned. Valid options: ages, audience, coreSets, codes, concepts, type, keywords, renditionLocalizations, title. A wildcard (*) may be passed to retrieve all data.

header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Response samples

Content type
application/json
{
  • "links": [
    ],
  • "hits": [
    ],
  • "top": 0,
  • "skip": 0,
  • "numberOfHits": 0
}

Retrieve an inventory of content for a specified core content set.

Authorizations:
token
path Parameters
coreSetId
required
string^(?i)CC_.*
Example: CC_00001

Specify the core content set from the Healthwise core content set library.

query Parameters
Retrieve
string
Example: Retrieve=title

A comma-delimited list of the data of the content to retrieve. The content ID and localization will always be returned. Valid options: ages, audience, coreSets, codes, concepts, type, keywords, renditionLocalizations, title. A wildcard (*) may be passed to retrieve all data.

Top
integer <int32> [ 1 .. 1000 ]
Skip
integer <int32> [ 0 .. 1000000 ]
header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Response samples

Content type
application/json
{
  • "links": [
    ],
  • "hits": [
    ],
  • "top": 0,
  • "skip": 0,
  • "numberOfHits": 0
}

Retrieve an inventory of content. Specify filters to limit the inventory.

Authorizations:
token
query Parameters
Id
string^[a-zA-Z0-9-]+(?:,[a-zA-Z0-9-]+)*$
Example: Id=abw4538,ack9130

Include only content with specified ID(s).

CoreSetId
string^[cC]{2}_\d+(?:,[cC]{2}_\d+)*$
Example: CoreSetId=CC_00001,CC_00002

Include only content for the specified core content set(s).

Concept
string^[hH][wW][cC][vV]_\d+(?:,[hH][wW][cC][vV]_\d+...
Example: Concept=HWCV_00001,HWCV_00002

Include only content for the specified concepts(s).

AgeGroup
string
Example: AgeGroup=senior,adult

Include only content for the specified age group(s). Valid options: senior, adult, teen, child, infant.

Type
string
Example: Type=video,image

Include only content for the specified type(s). Valid options: topic, video, image.

Aspect
string
Example: Aspect=whatIs,signsAndSymptoms

Include only content for the specified aspect(s). Valid options: diagnostics, selfCareTreatmentOverview, signsAndSymptoms, treatmentOverview, whatIs.

Audience
string
Example: Audience=patient

Include only content with the specified audience value(s). Valid options: patient, parent, caregiver

AvailableRenditionLocalization
string^[a-zA-Z]{2}-[a-zA-Z]{2}(?:,[a-zA-Z]{2}-[a-zA...
Example: AvailableRenditionLocalization=en-us,es-us

Include only content with renditions available in the specified localization(s).

Term
string^[a-zA-Z0-9\-_ ]+$
Example: Term=diabetes

Include only content that match the given search term.

Snomed
string^\d+(?:,\d+)*$
Example: Snomed=271737000

Include only content that is associated with the given SNOMED CT code(s).

Icd10Cm
string^[A-Za-z]\d{2}(?:\.\w+)?(?:,[A-Za-z]\d{2}(?:\...
Example: Icd10Cm=E78.5

Include only content that is associated with the given ICD-10-CM code(s).

Nucc
string^[a-zA-Z0-9]+(?:,[a-zA-Z0-9]+)*$
Example: Nucc=207Q00000X

Include only content that is associated with the given NUCC code(s).

Loinc
string^[a-zA-Z0-9]{1,10}-[a-zA-Z0-9](?:,^[a-zA-Z0-9...
Example: Loinc=44877-9

Include only content that is associated with the given LOINC code(s).

Cpt
string^\d+(?:,\d+)*$
Example: Cpt=99406

Include only content that is associated with the given CPT code(s).

RxNorm
string^\d+(?:,\d+)*$
Example: RxNorm=253182

Include only content that is associated with the given RxNorm code(s).

Retrieve
string
Example: Retrieve=title

A comma-delimited list of the data of the content to retrieve. The content ID and localization will always be returned. Valid options: ages, audience, coreSets, codes, concepts, type, keywords, renditionLocalizations, title. A wildcard (*) may be passed to retrieve all data.

Top
integer <int32> [ 1 .. 1000 ]
Skip
integer <int32> [ 0 .. 1000000 ]
header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Response samples

Content type
application/json
{
  • "links": [
    ],
  • "hits": [
    ],
  • "top": 0,
  • "skip": 0,
  • "numberOfHits": 0
}

ContentRendition

Retrieve the HTML rendition for the given localization and content ID.

Authorizations:
token
path Parameters
contentId
required
string^[a-zA-Z0-9-]+$
Example: acf1600

ID of content to render.

localization
required
string^[a-zA-Z]{2}-[a-zA-Z]{2}$
Example: en-us

Localization of content to render.

query Parameters
IncludeTitle
boolean

Include the title in the rendition.

IncludeAttribution
boolean

Include the attribution in the rendition.

header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Response samples

Content type
No sample

Retrieve the JSON rendition for the given localization and content ID.

Authorizations:
token
path Parameters
contentId
required
string^[a-zA-Z0-9-]+$
Example: acf1600

ID of content to render.

localization
required
string^[a-zA-Z]{2}-[a-zA-Z]{2}$
Example: en-us

Localization of content to render.

query Parameters
IncludeTitle
boolean

Include the title in the rendition.

IncludeAttribution
boolean

Include the attribution in the rendition.

header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Response samples

Content type
application/json
{
  • "code": "IntentionalGap",
  • "message": "string"
}

Retrieve the HTML rendition for the given localization, core content set, and aspect.

Authorizations:
token
path Parameters
coreSetId
required
string^[cC]{2}_\d+$
Example: CC_00001

Specify the core content set from the Healthwise core content set library.

aspect
required
string
Example: whatIs

Specify the aspect for the core content set.

localization
required
string^[a-zA-Z]{2}-[a-zA-Z]{2}$
Example: en-us

Specify the localization for the content.

query Parameters
Size
string
Example: Size=longest

The size of the content to render. Valid options: Short, Medium, Long, Shortest, Longest. Note that not all content has renditions for all sizes. If size is not specified, then the shortest will be returned.

IncludeTitle
boolean

Include the title in the rendition.

IncludeAttribution
boolean

Include the attribution in the rendition.

header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Response samples

Content type
No sample

Retrieve the JSON rendition for the given localization, core content set, and aspect.

Authorizations:
token
path Parameters
coreSetId
required
string^[cC]{2}_\d+$
Example: CC_00001

Specify the core content set from the Healthwise core content set library.

aspect
required
string
Example: whatIs

Specify the aspect for the core content set.

localization
required
string^[a-zA-Z]{2}-[a-zA-Z]{2}$
Example: en-us

Specify the localization for the content.

query Parameters
Size
string
Example: Size=longest

The size of the content to render. Valid options: Short, Medium, Long, Shortest, Longest. Note that not all content has renditions for all sizes. If size is not specified, then the shortest will be returned.

IncludeTitle
boolean

Include the title in the rendition.

IncludeAttribution
boolean

Include the attribution in the rendition.

header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Response samples

Content type
application/json
{
  • "code": "IntentionalGap",
  • "message": "string"
}

CoreSet

Retrieve an inventory of core content sets. Specify filters to limit the inventory.

Authorizations:
token
query Parameters
CoreSetId
string^[cC]{2}_\d+(?:,[cC]{2}_\d+)*$
Example: CoreSetId=CC_00001,CC_00002

Include only core content sets that have the specified core content set ID(s).

Term
string^[a-zA-Z0-9\-_ ]+$
Example: Term=diabetes

Include only core content sets that match the given search term. Note that the term must be HTML encoded.

Aspect
string
Example: Aspect=whatIs,signsAndSymptoms

Include only core content sets that support the given aspect(s). Aspects that are not clinically relevant for a medical concept are declared as intentional gaps and will be excluded. Valid options: diagnostics, selfCareTreatmentOverview, signsAndSymptoms, treatmentOverview, whatIs.

Concept
string^[hH][wW][cC][vV]_\d+(?:,[hH][wW][cC][vV]_\d+...
Example: Concept=HWCV_00001,HWCV_00002

Include only core content sets for the specified concepts(s).

Snomed
string^\d+(?:,\d+)*$
Example: Snomed=271737000

Include only core content sets that are associated with the given SNOMED CT code(s).

Icd10Cm
string^[A-Za-z]\d{2}(?:\.\w+)?(?:,[A-Za-z]\d{2}(?:\...
Example: Icd10Cm=E785

Include only core content sets that are associated with the given ICD-10-CM code(s).

Nucc
string^[a-zA-Z0-9]+(?:,[a-zA-Z0-9]+)*$
Example: Nucc=207Q00000X

Include only core content sets that are associated with the given NUCC code(s).

Loinc
string^[a-zA-Z0-9]{1,10}-[a-zA-Z0-9](?:,^[a-zA-Z0-9...
Example: Loinc=44877-9

Include only core content sets that are associated with the given LOINC code(s).

Cpt
string^\d+(?:,\d+)*$
Example: Cpt=99406

Include only core content sets that are associated with the given CPT code(s).

RxNorm
string^\d+(?:,\d+)*$
Example: RxNorm=253182

Include only core content sets that are associated with the given RxNorm code(s).

Retrieve
string
Example: Retrieve=title

A comma-delimited list of the core content data to retrieve. If not specified, only the core set ID will be returned. Valid options: aspects, codes, concepts, keywords, title. A wildcard (*) may be passed to retrieve all data.

Top
integer <int32> [ 1 .. 1000 ]
Skip
integer <int32> [ 0 .. 1000000 ]
header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Response samples

Content type
application/json
{
  • "links": [
    ],
  • "hits": [
    ],
  • "top": 0,
  • "skip": 0,
  • "numberOfHits": 0
}

Retrieve a core content set given an ID.

Authorizations:
token
path Parameters
coreSetId
required
string^[cC]{2}_\d+$
Example: CC_1600

ID of core content set to retrieve.

query Parameters
Retrieve
string
Example: Retrieve=title

A comma-delimited list of the core content data to retrieve. If not specified, only the core set ID will be returned. Valid options: aspects, codes, concepts, keywords, title. A wildcard (*) may be passed to retrieve all data.

header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Response samples

Content type
application/json
{
  • "links": [
    ],
  • "hits": [
    ],
  • "top": 0,
  • "skip": 0,
  • "numberOfHits": 0
}

LegalNotice

Retrieve the HTML-formatted Healthwise attribution for the given localization.

Authorizations:
token
path Parameters
localization
required
string^[a-zA-Z]{2}-[a-zA-Z]{2}$

Specify the localization for the attribution.

header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Retrieve the JSON-formatted Healthwise attribution for the given localization.

Authorizations:
token
path Parameters
localization
required
string^[a-zA-Z]{2}-[a-zA-Z]{2}$

Specify the localization for the attribution.

header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Retrieve the HTML-formatted adaptation disclaimer for the given localization.

Authorizations:
token
path Parameters
localization
required
string^[a-zA-Z]{2}-[a-zA-Z]{2}$

Specify the localization for the disclaimer.

header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses

Retrieve the JSON-formatted adaptation disclaimer for the given localization.

Authorizations:
token
path Parameters
localization
required
string^[a-zA-Z]{2}-[a-zA-Z]{2}$

Specify the localization for the disclaimer.

header Parameters
HW-Client-Use-Case
string

Terse description of the function of the calling application. This will make it so errors can be tied back to the use case or application.

Responses