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: Establishment Registration Logical Model

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

An operation to register Establishment organizations.

Establishment Registration UML Diagram

The following UML diagram shows the data elements for an Establishment Registration operation. 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 has the information about the Registrant, i.e the organization that is registering the establishments, and then one-to-many sets of Establishment information along with an optional US Agent and Importer (if the Establishment is not located in the US) and a set of Business Operations for the Establishment.

EstablishmentRegistrationstring operationIddateTime operationEffectiveTimestring requestIdstring requestVersionRegistrantstring dunsNumberstring nameContactPartystring nameAddress addressContactPoint telecomContactPoint emailEstablishmentstring dunsNumberstring feiNumber 0..1string nameAddress addressUSAgentstring dunsNumberstring nameContactPoint telecomContactPoint emailImporterstring dunsNumberstring nameContactPoint telecomContactPoint emailBusinessOperationCodeableConcept codeCodeableConcept qualifier 0..*1..*0..10..*1..*

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
.. EstablishmentRegistrationLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
Establishment Registration 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
... registrant 1..1 BackboneElement Registrant
.... dunsNumber 1..1 string Registrant DUNS Number
.... name 1..1 string Registrant Name
.... contactParty 1..1 BackboneElement Registrant Contact Party
..... name 1..1 string Registrant Contact Party Name
..... address 0..1 Address Registrant Contact Party Address
..... telephone 1..1 ContactPoint Registrant Contact Party Telephone Number
..... email 1..1 ContactPoint Registrant Contact Party Email Address
.... establishment 1..* BackboneElement Establishment
..... dunsNumber 1..1 string Establishment DUNS Number
..... feiNumber 1..1 string Establishment FDA Establishment Identifier
..... name 1..1 string Establishment Name
..... address 1..1 Address Establishment Address
..... contactParty 1..1 BackboneElement Establishment Contact Party
...... name 1..1 string Establishment Contact Party Name
...... address 0..1 Address Establishment Contact Party Address
...... telephone 1..1 ContactPoint Establishment Contact Party Telephone Number
...... email 1..1 ContactPoint Establishment Contact Party Email Address
..... usAgent 0..1 BackboneElement Establishment US Agent
...... dunsNumber 1..1 string Establishment US Agent DUNS Number
...... name 1..1 string Establishment US Agent Name
...... telephone 1..1 ContactPoint Establishment US Agent Telephone Number
...... email 1..1 ContactPoint Establishment US Agent Email Address
..... importer 0..* BackboneElement Establishment Importer
...... dunsNumber 1..1 string Establishment US Agent DUNS Number
...... name 1..1 string Establishment US Agent Name
...... telephone 1..1 ContactPoint Establishment US Agent Telephone Number
...... email 1..1 ContactPoint Establishment US Agent Email Address
..... businessOperation 1..* BackboneElement Establishment Business Operations
...... code 1..1 CodeableConcept Business Operation Type
...... qualifier 0..* CodeableConcept Business Operation Qualifier

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. EstablishmentRegistrationLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
Establishment Registration 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
... registrant 1..1 BackboneElement Registrant
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dunsNumber 1..1 string Registrant DUNS Number
.... name 1..1 string Registrant Name
.... contactParty 1..1 BackboneElement Registrant Contact Party
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Registrant Contact Party Name
..... address 0..1 Address Registrant Contact Party Address
..... telephone 1..1 ContactPoint Registrant Contact Party Telephone Number
..... email 1..1 ContactPoint Registrant Contact Party Email Address
.... establishment 1..* BackboneElement Establishment
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... dunsNumber 1..1 string Establishment DUNS Number
..... feiNumber 1..1 string Establishment FDA Establishment Identifier
..... name 1..1 string Establishment Name
..... address 1..1 Address Establishment Address
..... contactParty 1..1 BackboneElement Establishment Contact Party
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name 1..1 string Establishment Contact Party Name
...... address 0..1 Address Establishment Contact Party Address
...... telephone 1..1 ContactPoint Establishment Contact Party Telephone Number
...... email 1..1 ContactPoint Establishment Contact Party Email Address
..... usAgent 0..1 BackboneElement Establishment US Agent
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... dunsNumber 1..1 string Establishment US Agent DUNS Number
...... name 1..1 string Establishment US Agent Name
...... telephone 1..1 ContactPoint Establishment US Agent Telephone Number
...... email 1..1 ContactPoint Establishment US Agent Email Address
..... importer 0..* BackboneElement Establishment Importer
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... dunsNumber 1..1 string Establishment US Agent DUNS Number
...... name 1..1 string Establishment US Agent Name
...... telephone 1..1 ContactPoint Establishment US Agent Telephone Number
...... email 1..1 ContactPoint Establishment US Agent Email Address
..... businessOperation 1..* BackboneElement Establishment Business Operations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 CodeableConcept Business Operation Type
...... qualifier 0..* 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
.. EstablishmentRegistrationLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
Establishment Registration 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
... registrant 1..1 BackboneElement Registrant
.... @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 Registrant DUNS Number
.... name 1..1 string Registrant Name
.... contactParty 1..1 BackboneElement Registrant 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 Registrant Contact Party Name
..... address 0..1 Address Registrant Contact Party Address
..... telephone 1..1 ContactPoint Registrant Contact Party Telephone Number
..... email 1..1 ContactPoint Registrant Contact Party Email Address
.... establishment 1..* BackboneElement Establishment
..... @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 Establishment DUNS Number
..... feiNumber 1..1 string Establishment FDA Establishment Identifier
..... name 1..1 string Establishment Name
..... address 1..1 Address Establishment Address
..... contactParty 1..1 BackboneElement Establishment 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 Establishment Contact Party Name
...... address 0..1 Address Establishment Contact Party Address
...... telephone 1..1 ContactPoint Establishment Contact Party Telephone Number
...... email 1..1 ContactPoint Establishment Contact Party Email Address
..... usAgent 0..1 BackboneElement Establishment 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 Establishment US Agent DUNS Number
...... name 1..1 string Establishment US Agent Name
...... telephone 1..1 ContactPoint Establishment US Agent Telephone Number
...... email 1..1 ContactPoint Establishment US Agent Email Address
..... importer 0..* BackboneElement Establishment Importer
...... @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 Establishment US Agent DUNS Number
...... name 1..1 string Establishment US Agent Name
...... telephone 1..1 ContactPoint Establishment US Agent Telephone Number
...... email 1..1 ContactPoint Establishment US Agent Email Address
..... businessOperation 1..* BackboneElement Establishment 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..* 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(30 nested mandatory elements)

Maturity: 1

Differential View

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. EstablishmentRegistrationLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
Establishment Registration 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
... registrant 1..1 BackboneElement Registrant
.... dunsNumber 1..1 string Registrant DUNS Number
.... name 1..1 string Registrant Name
.... contactParty 1..1 BackboneElement Registrant Contact Party
..... name 1..1 string Registrant Contact Party Name
..... address 0..1 Address Registrant Contact Party Address
..... telephone 1..1 ContactPoint Registrant Contact Party Telephone Number
..... email 1..1 ContactPoint Registrant Contact Party Email Address
.... establishment 1..* BackboneElement Establishment
..... dunsNumber 1..1 string Establishment DUNS Number
..... feiNumber 1..1 string Establishment FDA Establishment Identifier
..... name 1..1 string Establishment Name
..... address 1..1 Address Establishment Address
..... contactParty 1..1 BackboneElement Establishment Contact Party
...... name 1..1 string Establishment Contact Party Name
...... address 0..1 Address Establishment Contact Party Address
...... telephone 1..1 ContactPoint Establishment Contact Party Telephone Number
...... email 1..1 ContactPoint Establishment Contact Party Email Address
..... usAgent 0..1 BackboneElement Establishment US Agent
...... dunsNumber 1..1 string Establishment US Agent DUNS Number
...... name 1..1 string Establishment US Agent Name
...... telephone 1..1 ContactPoint Establishment US Agent Telephone Number
...... email 1..1 ContactPoint Establishment US Agent Email Address
..... importer 0..* BackboneElement Establishment Importer
...... dunsNumber 1..1 string Establishment US Agent DUNS Number
...... name 1..1 string Establishment US Agent Name
...... telephone 1..1 ContactPoint Establishment US Agent Telephone Number
...... email 1..1 ContactPoint Establishment US Agent Email Address
..... businessOperation 1..* BackboneElement Establishment Business Operations
...... code 1..1 CodeableConcept Business Operation Type
...... qualifier 0..* CodeableConcept Business Operation Qualifier

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EstablishmentRegistrationLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
Establishment Registration 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
... registrant 1..1 BackboneElement Registrant
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dunsNumber 1..1 string Registrant DUNS Number
.... name 1..1 string Registrant Name
.... contactParty 1..1 BackboneElement Registrant Contact Party
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Registrant Contact Party Name
..... address 0..1 Address Registrant Contact Party Address
..... telephone 1..1 ContactPoint Registrant Contact Party Telephone Number
..... email 1..1 ContactPoint Registrant Contact Party Email Address
.... establishment 1..* BackboneElement Establishment
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... dunsNumber 1..1 string Establishment DUNS Number
..... feiNumber 1..1 string Establishment FDA Establishment Identifier
..... name 1..1 string Establishment Name
..... address 1..1 Address Establishment Address
..... contactParty 1..1 BackboneElement Establishment Contact Party
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... name 1..1 string Establishment Contact Party Name
...... address 0..1 Address Establishment Contact Party Address
...... telephone 1..1 ContactPoint Establishment Contact Party Telephone Number
...... email 1..1 ContactPoint Establishment Contact Party Email Address
..... usAgent 0..1 BackboneElement Establishment US Agent
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... dunsNumber 1..1 string Establishment US Agent DUNS Number
...... name 1..1 string Establishment US Agent Name
...... telephone 1..1 ContactPoint Establishment US Agent Telephone Number
...... email 1..1 ContactPoint Establishment US Agent Email Address
..... importer 0..* BackboneElement Establishment Importer
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... dunsNumber 1..1 string Establishment US Agent DUNS Number
...... name 1..1 string Establishment US Agent Name
...... telephone 1..1 ContactPoint Establishment US Agent Telephone Number
...... email 1..1 ContactPoint Establishment US Agent Email Address
..... businessOperation 1..* BackboneElement Establishment Business Operations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 CodeableConcept Business Operation Type
...... qualifier 0..* 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
.. EstablishmentRegistrationLogicalModel 0..* Element
Elements defined in Ancestors:@id, extension
Establishment Registration 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
... registrant 1..1 BackboneElement Registrant
.... @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 Registrant DUNS Number
.... name 1..1 string Registrant Name
.... contactParty 1..1 BackboneElement Registrant 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 Registrant Contact Party Name
..... address 0..1 Address Registrant Contact Party Address
..... telephone 1..1 ContactPoint Registrant Contact Party Telephone Number
..... email 1..1 ContactPoint Registrant Contact Party Email Address
.... establishment 1..* BackboneElement Establishment
..... @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 Establishment DUNS Number
..... feiNumber 1..1 string Establishment FDA Establishment Identifier
..... name 1..1 string Establishment Name
..... address 1..1 Address Establishment Address
..... contactParty 1..1 BackboneElement Establishment 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 Establishment Contact Party Name
...... address 0..1 Address Establishment Contact Party Address
...... telephone 1..1 ContactPoint Establishment Contact Party Telephone Number
...... email 1..1 ContactPoint Establishment Contact Party Email Address
..... usAgent 0..1 BackboneElement Establishment 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 Establishment US Agent DUNS Number
...... name 1..1 string Establishment US Agent Name
...... telephone 1..1 ContactPoint Establishment US Agent Telephone Number
...... email 1..1 ContactPoint Establishment US Agent Email Address
..... importer 0..* BackboneElement Establishment Importer
...... @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 Establishment US Agent DUNS Number
...... name 1..1 string Establishment US Agent Name
...... telephone 1..1 ContactPoint Establishment US Agent Telephone Number
...... email 1..1 ContactPoint Establishment US Agent Email Address
..... businessOperation 1..* BackboneElement Establishment 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..* 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(30 nested mandatory elements)

Maturity: 1

 

Other representations of profile: CSV, Excel