Standard Health Record FHIR Implementation Guide

SHR OrganizationalIdentifier Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-OrganizationalIdentifier

A code identifying a specific organization. The NPI should be provided, if available. Other business identifiers, such employer tax ID, or MVX code for vaccine manufacturers, should also be provided.

This profile builds on Identifier.

This profile was published on Wed Dec 20 00:00:00 EST 2017 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

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

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.core.OrganizationalIdentifier maps to Identifier:
  string maps to value
  Purpose maps to use
  Type maps to type
  CodeSystem maps to system 
  EffectiveTimePeriod maps to period
  Issuer maps to assigner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier SHR OrganizationalIdentifier Profile
... value 1..1
... assigner Reference(SHR Organization Profile)
... shr-core-TimePeriod-extension 0..1PeriodSHR TimePeriod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-TimePeriod-extension
Slice: Unordered, Open by value:url
... shr-entity-Organization-extension 0..1Reference(SHR Organization Profile)SHR Organization Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Organization-extension
Slice: Unordered, Open by value:url

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*SHR OrganizationalIdentifier Profile
... id 0..1stringxml:id (or equivalent in JSON)
... shr-core-TimePeriod-extension 0..1PeriodSHR TimePeriod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-TimePeriod-extension
Slice: Unordered, Open by value:url
... shr-entity-Organization-extension 0..1Reference(SHR Organization Profile)SHR Organization Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Organization-extension
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
... value Σ1..1stringThe value that is unique
Example General': 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(SHR Organization Profile)Organization that issued id (may be just text)

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.core.OrganizationalIdentifier maps to Identifier:
  string maps to value
  Purpose maps to use
  Type maps to type
  CodeSystem maps to system 
  EffectiveTimePeriod maps to period
  Issuer maps to assigner

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier SHR OrganizationalIdentifier Profile
... value 1..1
... assigner Reference(SHR Organization Profile)
... shr-core-TimePeriod-extension 0..1PeriodSHR TimePeriod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-TimePeriod-extension
Slice: Unordered, Open by value:url
... shr-entity-Organization-extension 0..1Reference(SHR Organization Profile)SHR Organization Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Organization-extension
Slice: Unordered, Open by value:url

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*SHR OrganizationalIdentifier Profile
... id 0..1stringxml:id (or equivalent in JSON)
... shr-core-TimePeriod-extension 0..1PeriodSHR TimePeriod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-TimePeriod-extension
Slice: Unordered, Open by value:url
... shr-entity-Organization-extension 0..1Reference(SHR Organization Profile)SHR Organization Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Organization-extension
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
... value Σ1..1stringThe value that is unique
Example General': 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(SHR Organization Profile)Organization that issued id (may be just text)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
Identifier.useIdentifierUserequiredIdentifierUse
Identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes

 

Constraints

IdPathDetailsRequirements
ele-1IdentifierAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())