Da Vinci Health Record Exchange (HRex)
0.2.0 - STU R1 - 2nd ballot

This page is part of the Da Vinci Health Record Exchange (v0.2.0: STU1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: HRexOrganization

Additional Da Vinci constraints on organization - to represent either provider organizations or payers

The official URL for this profile is:

http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-organization

In Da Vinci, organization is typically used to represent either a payer or provider organization. Da Vinci extends to US Core profile to support some additional identifier types and, based on that increased flexibility, to mandate that an identifier must be present. (In Da Vinci, there is little utility in referencing an organization that cannot be computably identified.)

Formal Views of Profile Content

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

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 1 element
Must-Support: 2 elements

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... identifier 1..*IdentifierIdentifies this organization across multiple systems
... identifier:tin S0..1IdentifierIdentifies this organization across multiple systems
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
... identifier:ccn S0..1IdentifierIdentifies this organization across multiple systems
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI1..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CLIA SΣI0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:tin SΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ccn SΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣI1..1booleanWhether the organization's record is still in active use
... type ΣI0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SΣI1..1stringName used for the organization
... alias I0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI0..*ContactPointA contact detail for the organization
... address SI0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type ΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣI0..4stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣI0..1stringName of city, town etc.
Example General: Erewhon
.... district ΣI0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣI0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣI0..1stringUS Zip Codes
Example General: 9132
.... country SΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period ΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
... partOf ΣI0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose I0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name I0..1HumanNameA name associated with the contact
.... telecom I0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address I0..1AddressVisiting or postal addresses for the contact
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... identifier ΣI1..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI ΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CLIA ΣI0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:tin ΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ccn ΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI1..1booleanWhether the organization's record is still in active use
... name ΣI1..1stringName used for the organization
... address I0..*AddressAn address for the organization
.... line ΣI0..4stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city ΣI0..1stringName of city, town etc.
.... state ΣI0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode ΣI0..1stringUS Zip Codes
.... country ΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 1 element
Must-Support: 2 elements

Differential View

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... identifier 1..*IdentifierIdentifies this organization across multiple systems
... identifier:tin S0..1IdentifierIdentifies this organization across multiple systems
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
... identifier:ccn S0..1IdentifierIdentifies this organization across multiple systems
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI1..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CLIA SΣI0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:tin SΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.4
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ccn SΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣI1..1booleanWhether the organization's record is still in active use
... type ΣI0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SΣI1..1stringName used for the organization
... alias I0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI0..*ContactPointA contact detail for the organization
... address SI0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type ΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣI0..4stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣI0..1stringName of city, town etc.
Example General: Erewhon
.... district ΣI0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣI0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣI0..1stringUS Zip Codes
Example General: 9132
.... country SΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period ΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
... partOf ΣI0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose I0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name I0..1HumanNameA name associated with the contact
.... telecom I0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address I0..1AddressVisiting or postal addresses for the contact
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Organization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Organization.typeexampleOrganizationType
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
Organization.contact.purposeextensibleContactEntityType

Constraints

IdPathDetailsRequirements
dom-2OrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3OrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4OrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5OrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6OrganizationA resource should have narrative for robust management
: text.`div`.exists()
org-1OrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
ele-1Organization.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:NPIAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:CLIAAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:tinAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:ccnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.aliasAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-3Organization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1Organization.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-2Organization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1Organization.address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())