SPL Mapping FHIR R5 Implementation Guide
0.2.1 - Build CI United States of America flag

SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions

Logical Model: NDC Labeler Code Request Logical Model

Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/LabelerCodeRequestLogicalModel Version: 0.2.1
Standards status: Trial-use Maturity Level: 1 Computable Name: LabelerCodeRequestLogicalModel

An operation to request a NDC Labeler code for a registrant or private Labeler organization.

Labeler Code Request UML Diagram

The following UML diagram shows the data elements for a Labeler Code Request. More details about the data elements can be found in the definition tables below.

Each request has a set of elements that identify the request:

  • operation ID
  • operation date/time
  • request ID
  • request version

It then carries the content of the request which is a Labeler with an optional US Agent (if the Labeler is not located in the US) and a set of Business Operations.

LabelerCodeRequeststring operationIddateTime operationEffectiveTimestring requestIdstring requestVersionLabelerstring dunsNumberstring labelerCode 0..1string nameAddress address 0..1ContactPartystring nameAddress addressContactPoint telecomContactPoint emailUSAgentstring dunsNumberstring nameContactPoint telecomContactPoint emailBusinessOperationCodeableConcept codeCodeableConcept qualifier 0..20..11..*

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. LabelerCodeRequestLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
NDC Labeler Code Request Logical Model
Instances of this logical model are not marked to be the target of a Reference
... operationId 1..1 string Operation Identifier
... operationEffectiveTime 1..1 dateTime Operation Effective Time
... requestId 1..1 string Request Identifier
... labeler 1..1 BackboneElement Labeler
.... dunsNumber 1..1 string Labeler DUNS Number
.... labelerCode 0..1 string NDC Labeler Code
.... name 1..1 string Labeler Name
.... address 0..1 Address Labeler Address
.... contactParty 1..1 BackboneElement Labeler Contact Party
..... name 1..1 string Labeler Contact Party Name
..... telephone 1..1 ContactPoint Labeler Contact Party Telephone Number
..... email 1..1 ContactPoint Labeler Contact Party Email Address
.... usAgent 1..1 BackboneElement Labeler US Agent
..... dunsNumber 1..1 string Labeler US Agent DUNS Number
..... name 1..1 string Labeler US Agent Name
..... telephone 1..1 ContactPoint Labeler US Agent Telephone Number
..... email 1..1 ContactPoint Labeler US Agent Email Address
.... businessOperation 1..* BackboneElement Labeler Business Operations
..... code 1..1 CodeableConcept Business Operation Type
..... qualifier 0..2 CodeableConcept Business Operation Qualifier

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. LabelerCodeRequestLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
NDC Labeler Code Request Logical Model
Instances of this logical model are not marked to be the target of a Reference
... operationId 1..1 string Operation Identifier
... operationEffectiveTime 1..1 dateTime Operation Effective Time
... requestId 1..1 string Request Identifier
... labeler 1..1 BackboneElement Labeler
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dunsNumber 1..1 string Labeler DUNS Number
.... labelerCode 0..1 string NDC Labeler Code
.... name 1..1 string Labeler Name
.... address 0..1 Address Labeler Address
.... contactParty 1..1 BackboneElement Labeler Contact Party
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Labeler Contact Party Name
..... telephone 1..1 ContactPoint Labeler Contact Party Telephone Number
..... email 1..1 ContactPoint Labeler Contact Party Email Address
.... usAgent 1..1 BackboneElement Labeler US Agent
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... dunsNumber 1..1 string Labeler US Agent DUNS Number
..... name 1..1 string Labeler US Agent Name
..... telephone 1..1 ContactPoint Labeler US Agent Telephone Number
..... email 1..1 ContactPoint Labeler US Agent Email Address
.... businessOperation 1..* BackboneElement Labeler Business Operations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Business Operation Type
..... qualifier 0..2 CodeableConcept Business Operation Qualifier

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. LabelerCodeRequestLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
NDC Labeler Code Request Logical Model
Instances of this logical model are not marked to be the target of a Reference
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... operationId 1..1 string Operation Identifier
... requestId 1..1 string Request Identifier
... requestVersion 1..1 string Request Version Number
... labeler 1..1 BackboneElement Labeler
.... @id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dunsNumber 1..1 string Labeler DUNS Number
.... labelerCode 0..1 string NDC Labeler Code
.... name 1..1 string Labeler Name
.... address 0..1 Address Labeler Address
.... contactParty 1..1 BackboneElement Labeler Contact Party
..... @id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Labeler Contact Party Name
..... telephone 1..1 ContactPoint Labeler Contact Party Telephone Number
..... email 1..1 ContactPoint Labeler Contact Party Email Address
.... usAgent 1..1 BackboneElement Labeler US Agent
..... @id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... dunsNumber 1..1 string Labeler US Agent DUNS Number
..... name 1..1 string Labeler US Agent Name
..... telephone 1..1 ContactPoint Labeler US Agent Telephone Number
..... email 1..1 ContactPoint Labeler US Agent Email Address
.... businessOperation 1..* BackboneElement Labeler Business Operations
..... @id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Business Operation Type
..... qualifier 0..2 CodeableConcept Business Operation Qualifier

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Element

Summary

Mandatory: 0 element(18 nested mandatory elements)

Maturity: 1

Differential View

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. LabelerCodeRequestLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
NDC Labeler Code Request Logical Model
Instances of this logical model are not marked to be the target of a Reference
... operationId 1..1 string Operation Identifier
... operationEffectiveTime 1..1 dateTime Operation Effective Time
... requestId 1..1 string Request Identifier
... labeler 1..1 BackboneElement Labeler
.... dunsNumber 1..1 string Labeler DUNS Number
.... labelerCode 0..1 string NDC Labeler Code
.... name 1..1 string Labeler Name
.... address 0..1 Address Labeler Address
.... contactParty 1..1 BackboneElement Labeler Contact Party
..... name 1..1 string Labeler Contact Party Name
..... telephone 1..1 ContactPoint Labeler Contact Party Telephone Number
..... email 1..1 ContactPoint Labeler Contact Party Email Address
.... usAgent 1..1 BackboneElement Labeler US Agent
..... dunsNumber 1..1 string Labeler US Agent DUNS Number
..... name 1..1 string Labeler US Agent Name
..... telephone 1..1 ContactPoint Labeler US Agent Telephone Number
..... email 1..1 ContactPoint Labeler US Agent Email Address
.... businessOperation 1..* BackboneElement Labeler Business Operations
..... code 1..1 CodeableConcept Business Operation Type
..... qualifier 0..2 CodeableConcept Business Operation Qualifier

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. LabelerCodeRequestLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
NDC Labeler Code Request Logical Model
Instances of this logical model are not marked to be the target of a Reference
... operationId 1..1 string Operation Identifier
... operationEffectiveTime 1..1 dateTime Operation Effective Time
... requestId 1..1 string Request Identifier
... labeler 1..1 BackboneElement Labeler
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dunsNumber 1..1 string Labeler DUNS Number
.... labelerCode 0..1 string NDC Labeler Code
.... name 1..1 string Labeler Name
.... address 0..1 Address Labeler Address
.... contactParty 1..1 BackboneElement Labeler Contact Party
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Labeler Contact Party Name
..... telephone 1..1 ContactPoint Labeler Contact Party Telephone Number
..... email 1..1 ContactPoint Labeler Contact Party Email Address
.... usAgent 1..1 BackboneElement Labeler US Agent
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... dunsNumber 1..1 string Labeler US Agent DUNS Number
..... name 1..1 string Labeler US Agent Name
..... telephone 1..1 ContactPoint Labeler US Agent Telephone Number
..... email 1..1 ContactPoint Labeler US Agent Email Address
.... businessOperation 1..* BackboneElement Labeler Business Operations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Business Operation Type
..... qualifier 0..2 CodeableConcept Business Operation Qualifier

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. LabelerCodeRequestLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
NDC Labeler Code Request Logical Model
Instances of this logical model are not marked to be the target of a Reference
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... operationId 1..1 string Operation Identifier
... requestId 1..1 string Request Identifier
... requestVersion 1..1 string Request Version Number
... labeler 1..1 BackboneElement Labeler
.... @id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dunsNumber 1..1 string Labeler DUNS Number
.... labelerCode 0..1 string NDC Labeler Code
.... name 1..1 string Labeler Name
.... address 0..1 Address Labeler Address
.... contactParty 1..1 BackboneElement Labeler Contact Party
..... @id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Labeler Contact Party Name
..... telephone 1..1 ContactPoint Labeler Contact Party Telephone Number
..... email 1..1 ContactPoint Labeler Contact Party Email Address
.... usAgent 1..1 BackboneElement Labeler US Agent
..... @id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... dunsNumber 1..1 string Labeler US Agent DUNS Number
..... name 1..1 string Labeler US Agent Name
..... telephone 1..1 ContactPoint Labeler US Agent Telephone Number
..... email 1..1 ContactPoint Labeler US Agent Email Address
.... businessOperation 1..* BackboneElement Labeler Business Operations
..... @id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Business Operation Type
..... qualifier 0..2 CodeableConcept Business Operation Qualifier

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Element

Summary

Mandatory: 0 element(18 nested mandatory elements)

Maturity: 1

 

Other representations of profile: CSV, Excel