Harvard Health Content External Web Service Documentation
Terminology
To understand the web service, it is important to understand some basic terminology.
Content Id - The Content Id is a unique number within a Content Type that is used to identify content. The combination of Content Type Id and Content Id uniquely identifies each piece of content.
Content Type Id - An Id that identifies the Business Unit Content Type of content. All content is organized into content types. Some example content types include "Daily News", "Drug Reference", and "Videos". The organization of content into content types is a business unit specific task for internal organization and doesn't necessarily give any indication of what topics are included in the content.
Content Object - This refers to all of the data necessary to define a specific piece of content in the repository, be it a document or a streaming media object, including the displayable portion as well as any associated meta data. Common meta data elements include language code, alternate languages, blurb, title, authors, and indexing information.
License - A license is the mechanism used for assigning content to a paid subscriber. All licenses have access to one or more content types. All access to the web service requires sending the sitename of the license in the URL.
SEO - Search Engine Optimization.
Service Lines -
- Serviceline Keyword - The Serviceline Keyword is one of approximately seventy types of clinical services lines and physician specialties commonly found in hospitals, such as, cardiology, orthopedics, gastroenterology, etc. This field is commonly used to identify and group content related to a specific clinical service line or physician specialty.
- Page Keyword - The Page Keyword is one of approximately two thousand of the most common conditions, tests, procedures or topics, such as, atrial fibrillation, cardiac catheterization, etc. that represent the primary focus of a document's content. This field is commonly used to identify content that can be related to a very specific sub-specialty service or physician special clinical interest.
- Audience - The Audience indicates the age group for which the condition/article is relevant.
UCR - Short for "Unified Content Repository". This is the content repository for all Harvard Health Publications content.
Dates
- PublishedDate - This date represents when the article is published and available to be picked up by a web service call.
- PlannedPublicationDate - This date represents when an article is scheduled for. This is important for articles that might have an embargo due to a medical study release. If there is no Planned Publication Date or it is the same as the Published date, there is no embargo and the article can be posted immediately.
Content types this effects:
- Blogs (ID: 179)
- Newsletters* (ID: 69)
For example: Articles for the December 2016 issue are made available to customers on November 15th. They shouldn't be published until December 1st. - LastReviewedDate - This date represents the last time a medically licensed doctor has reviewed the content in the article.
- LastModifiedDate - This date represents the last time this article was modified. Reasons an article is modified include:
- Corrections and updates in an article ( of drug names or grammar/spelling)
- Updated medical tagging
- Metadata update to any field