FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

15.15.0 MarketingStatus

Pharmacy

Work Group

Maturity Level: 3

Standards Status: Trial Use

Types Framework Cross Reference: Base Types | Datatypes | Resources | Patterns

The MarketingStatus structure allows specifying that an item or product is on the market for sale, or that it is not available, and the dates associated. This refers to a marketing choice rather than having permission, and so is a different concept to it being approved, cleared or licenced to be on sale (for which see RegulatedAuthorization).

Note: the MarketingStatus structure allows modifier extensions.

15.15.0.1 Content

Structure

Name	Flags	Card.	Type	Description & Constraints
MarketingStatus	Σ D		Element	The marketing status describes the date when an item is actually put on the market or the date as of which it is no longer available Elements defined in Ancestors: id, extension, modifierExtension
country	Σ	0..1	CodeableConcept	The country in which the marketing status applies
jurisdiction	Σ	0..1	CodeableConcept	The jurisdiction in which the marketing status applies
status	Σ	1..1	CodeableConcept	This attribute provides information on the status of the marketing of the item
dateRange	Σ	0..1	Period	The dates that the item is made available on the market by the owner (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction. Note that “on the market” refers to the release of the item into the distribution chain
restoreDate	Σ	0..1	dateTime	The date when the item is due to be placed back on the market by the owner, manufacturer or distributor, after a suspension
Documentation for this format

Definition: XML | JSON

XML Template

<MarketingStatus xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <country><!-- 0..1 CodeableConcept The country in which the marketing status applies --></country>
 <jurisdiction><!-- 0..1 CodeableConcept The jurisdiction in which the marketing status applies --></jurisdiction>
 <status><!-- 1..1 CodeableConcept This attribute provides information on the status of the marketing of the item --></status>
 <dateRange><!-- 0..1 Period The dates that the item is made available on the market by the owner (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction. Note that “on the market” refers to the release of the item into the distribution chain --></dateRange>
 <restoreDate value="[dateTime]"/><!-- 0..1 The date when the item is due to be placed back on the market by the owner, manufacturer or distributor, after a suspension -->
</MarketingStatus>

JSON Template

{
  // from Element: extension
  "country" : { CodeableConcept }, // The country in which the marketing status applies
  "jurisdiction" : { CodeableConcept }, // The jurisdiction in which the marketing status applies
  "status" : { CodeableConcept }, // R!  This attribute provides information on the status of the marketing of the item
  "dateRange" : { Period }, // The dates that the item is made available on the market by the owner (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction. Note that “on the market” refers to the release of the item into the distribution chain
  "restoreDate" : "<dateTime>" // The date when the item is due to be placed back on the market by the owner, manufacturer or distributor, after a suspension
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:country [ CodeableConcept ] ; # 0..1 The country in which the marketing status applies
  fhir:jurisdiction [ CodeableConcept ] ; # 0..1 The jurisdiction in which the marketing status applies
  fhir:status [ CodeableConcept ] ; # 1..1 This attribute provides information on the status of the marketing of the item
  fhir:dateRange [ Period ] ; # 0..1 The dates that the item is made available on the market by the owner (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction. Note that “on the market” refers to the release of the item into the distribution chain
  fhir:restoreDate [ dateTime ] ; # 0..1 The date when the item is due to be placed back on the market by the owner, manufacturer or distributor, after a suspension
]

Structure

Name	Flags	Card.	Type	Description & Constraints
MarketingStatus	Σ D		Element	The marketing status describes the date when an item is actually put on the market or the date as of which it is no longer available Elements defined in Ancestors: id, extension, modifierExtension
country	Σ	0..1	CodeableConcept	The country in which the marketing status applies
jurisdiction	Σ	0..1	CodeableConcept	The jurisdiction in which the marketing status applies
status	Σ	1..1	CodeableConcept	This attribute provides information on the status of the marketing of the item
dateRange	Σ	0..1	Period	The dates that the item is made available on the market by the owner (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction. Note that “on the market” refers to the release of the item into the distribution chain
restoreDate	Σ	0..1	dateTime	The date when the item is due to be placed back on the market by the owner, manufacturer or distributor, after a suspension
Documentation for this format

UML Diagram (Legend)

XML Template

<MarketingStatus xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <country><!-- 0..1 CodeableConcept The country in which the marketing status applies --></country>
 <jurisdiction><!-- 0..1 CodeableConcept The jurisdiction in which the marketing status applies --></jurisdiction>
 <status><!-- 1..1 CodeableConcept This attribute provides information on the status of the marketing of the item --></status>
 <dateRange><!-- 0..1 Period The dates that the item is made available on the market by the owner (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction. Note that “on the market” refers to the release of the item into the distribution chain --></dateRange>
 <restoreDate value="[dateTime]"/><!-- 0..1 The date when the item is due to be placed back on the market by the owner, manufacturer or distributor, after a suspension -->
</MarketingStatus>

JSON Template

{
  // from Element: extension
  "country" : { CodeableConcept }, // The country in which the marketing status applies
  "jurisdiction" : { CodeableConcept }, // The jurisdiction in which the marketing status applies
  "status" : { CodeableConcept }, // R!  This attribute provides information on the status of the marketing of the item
  "dateRange" : { Period }, // The dates that the item is made available on the market by the owner (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction. Note that “on the market” refers to the release of the item into the distribution chain
  "restoreDate" : "<dateTime>" // The date when the item is due to be placed back on the market by the owner, manufacturer or distributor, after a suspension
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:country [ CodeableConcept ] ; # 0..1 The country in which the marketing status applies
  fhir:jurisdiction [ CodeableConcept ] ; # 0..1 The jurisdiction in which the marketing status applies
  fhir:status [ CodeableConcept ] ; # 1..1 This attribute provides information on the status of the marketing of the item
  fhir:dateRange [ Period ] ; # 0..1 The dates that the item is made available on the market by the owner (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction. Note that “on the market” refers to the release of the item into the distribution chain
  fhir:restoreDate [ dateTime ] ; # 0..1 The date when the item is due to be placed back on the market by the owner, manufacturer or distributor, after a suspension
]

Changes since Release 3

Changes from both R4 and R4B

MarketingStatus

MarketingStatus.country

Min Cardinality changed from 1 to 0

MarketingStatus.dateRange

Min Cardinality changed from 1 to 0

See the Full Difference for further information

Constraints

MarketingStatus is used in the following places: ManufacturedItemDefinition, MedicinalProductDefinition and PackagedProductDefinition