Sequoia Project Healthcare Directory Implementation Guide
0.0.4 - CI Build US

Sequoia Project Healthcare Directory Implementation Guide - Local Development build (v0.0.4). See the Directory of published versions

Resource Profile: Sequoia Organization ( Abstract )

Official URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/SequoiaOrganization Version: 0.0.4
Active as of 2022-11-04 Computable Name: SequoiaOrganization

Copyright/Legal: This document is copyright 2017-18 by The Sequoia Project. All rights reserved world wide.

Usage:

  • Refer to this Resource Profile:

Formal Views of Profile Content

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

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileThis is an abstract profile.
A grouping of people or organizations with a common purpose
so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
... Domains S1..*CodingDomains
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
... HubServiceSubscriptions 0..*CodingHubServiceSubscription
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
... AdministrativeStatus 0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
... InitiatorOnly S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
... org-businesskey S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey
... org-managing-org S0..1Reference(Sequoia Organization)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (required)
... StateOfOperation S0..*AddressExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
... UseCases S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
... identifier:CCN S0..1IdentifierCMS Certification Number (CCN)
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.336
... identifier:HCID S1..1IdentifierOID (such as a Home Community ID) or UUID
Required Pattern: At least the following
.... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: HCID
.... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
... active S1..1booleanWhether the organization's record is still in active use
... Slices for type S1..*CodeableConceptKind of organization
Slice: Unordered, Open by pattern:$this
.... type:sequoiaorgtype S1..1CodeableConceptKind of organization
Binding: Organization Type (required)
.... type:hl7orgrole S0..*CodeableConceptKind of organization
Binding: OrganizationAffiliationRole (required)
... name S1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom S0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:phone S0..*ContactPointA contact detail for the organization
..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
.... telecom:email S0..*ContactPointA contact detail for the organization
..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
... address S0..*AddressAn address for the organization
.... OrgLocation S0..*Reference(Sequoia Location)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
.... line S0..1stringStreet name, number, direction & P.O. Box etc.
.... city S0..1stringName of city, town etc.
.... state S0..1stringSub-unit of country (abbreviations ok)
.... postalCode S0..1stringUS Zip Codes
.... country S0..1stringMust be an ISO 3166 3 letter code
... partOf S0..1Reference(Sequoia Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... company S0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
.... Slices for telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system S0..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
..... telecom:email S0..1ContactPointContact details (telephone, email, etc.) for a contact
...... system S0..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
.... address S0..1AddressVisiting or postal addresses for the contact
..... line S0..1stringStreet name, number, direction & P.O. Box etc.
... endpoint S0..*Reference(Sequoia Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organization.type:sequoiaorgtyperequiredOrganizationType
Organization.type:hl7orgrolerequiredOrganizationAffiliationRole

Constraints

IdGradePath(s)DetailsRequirements
so-1warningOrganizationFor any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileThis is an abstract profile.
A grouping of people or organizations with a common purpose
so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Domains S1..*CodingDomains
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
... HubServiceSubscriptions 0..*CodingHubServiceSubscription
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
... HubRoutingStatus 0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
... InitiatorOnly S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
... org-businesskey S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey
... org-managing-org S0..1Reference(Sequoia Organization)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (required)
... StateOfOperation S0..*AddressExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
... UseCases S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... identifier:CLIA ΣC0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
.... identifier:CCN SΣC0..1IdentifierCMS Certification Number (CCN)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.336
.... identifier:HCID SΣC1..1IdentifierOID (such as a Home Community ID) or UUID

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HCID
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... Slices for type SΣ1..*CodeableConceptKind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.


.... type:sequoiaorgtype SΣ1..1CodeableConceptKind of organization
Binding: Organization Type (required)
.... type:hl7orgrole SΣ0..*CodeableConceptKind of organization
Binding: OrganizationAffiliationRole (required)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... telecom:phone SC0..*ContactPointA contact detail for the organization
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... telecom:email SC0..*ContactPointA contact detail for the organization
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... address SC0..*AddressAn address for the organization
.... OrgLocation S0..*Reference(Sequoia Location)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..1stringStreet 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Σ0..1stringName of city, town etc.
Example General: Erewhon
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringMust be an ISO 3166 3 letter code
... partOf SΣ0..1Reference(Sequoia Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... company S0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... telecom:email S0..1ContactPointContact details (telephone, email, etc.) for a contact
...... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... address S0..1AddressVisiting or postal addresses for the contact
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... line SΣ0..1stringStreet 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
... endpoint S0..*Reference(Sequoia Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.typeexampleOrganizationType
Organization.type:sequoiaorgtyperequiredOrganizationType
Organization.type:hl7orgrolerequiredOrganizationAffiliationRole
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.telecom:phone.systemrequiredFixed Value: phone
Organization.telecom:phone.userequiredContactPointUse
Organization.telecom:email.systemrequiredFixed Value: email
Organization.telecom:email.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Organization.contact.telecom:phone.systemrequiredFixed Value: phone
Organization.contact.telecom:phone.userequiredContactPointUse
Organization.contact.telecom:email.systemrequiredFixed Value: email
Organization.contact.telecom:email.userequiredContactPointUse
Organization.contact.address.userequiredAddressUse

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
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()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:phone, Organization.telecom:emailThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
so-1warningOrganizationFor any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileThis is an abstract profile.
A grouping of people or organizations with a common purpose
so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Domains S1..*CodingDomains
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
... HubServiceSubscriptions 0..*CodingHubServiceSubscription
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
... AdministrativeStatus 0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
... HubRoutingStatus 0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
... InitiatorOnly S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
... org-businesskey S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey
... org-managing-org S0..1Reference(Sequoia Organization)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (required)
... StateOfOperation S0..*AddressExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
... UseCases S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1idUnique 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 ΣC0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1idUnique 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:CCN SΣC0..1IdentifierCMS Certification Number (CCN)

Required Pattern: At least the following
..... id0..1idUnique 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.336
..... 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:HCID SΣC1..1IdentifierOID (such as a Home Community ID) or UUID

Required Pattern: At least the following
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HCID
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... 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Σ1..1booleanWhether the organization's record is still in active use
... Slices for type SΣ1..*CodeableConceptKind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.


.... type:sequoiaorgtype SΣ1..1CodeableConceptKind of organization
Binding: Organization Type (required)
.... type:hl7orgrole SΣ0..*CodeableConceptKind of organization
Binding: OrganizationAffiliationRole (required)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:phone SC0..*ContactPointA contact detail for the organization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email SC0..*ContactPointA contact detail for the organization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address SC0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... OrgLocation S0..*Reference(Sequoia Location)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..1stringStreet 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Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringMust be an ISO 3166 3 letter code
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ0..1Reference(Sequoia Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... company S0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... Slices for telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
...... value Σ0..1stringThe actual contact point details
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
..... telecom:email S0..1ContactPointContact details (telephone, email, etc.) for a contact
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
...... value Σ0..1stringThe actual contact point details
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressVisiting or postal addresses for the contact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ0..1stringStreet 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 Σ0..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint S0..*Reference(Sequoia Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.typeexampleOrganizationType
Organization.type:sequoiaorgtyperequiredOrganizationType
Organization.type:hl7orgrolerequiredOrganizationAffiliationRole
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.telecom:phone.systemrequiredFixed Value: phone
Organization.telecom:phone.userequiredContactPointUse
Organization.telecom:email.systemrequiredFixed Value: email
Organization.telecom:email.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Organization.contact.purposeextensibleContactEntityType
Organization.contact.telecom:phone.systemrequiredFixed Value: phone
Organization.contact.telecom:phone.userequiredContactPointUse
Organization.contact.telecom:email.systemrequiredFixed Value: email
Organization.contact.telecom:email.userequiredContactPointUse
Organization.contact.address.userequiredAddressUse
Organization.contact.address.typerequiredAddressType

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()
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:phone, Organization.telecom:emailThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 4 elements (2 nested mandatory elements)
Must-Support: 38 elements
Fixed Value: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Organization.type is sliced based on the value of pattern:$this
  • The element Organization.telecom is sliced based on the value of value:system
  • The element Organization.contact.telecom is sliced based on the value of value:system

Differential View

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileThis is an abstract profile.
A grouping of people or organizations with a common purpose
so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
... Domains S1..*CodingDomains
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
... HubServiceSubscriptions 0..*CodingHubServiceSubscription
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
... AdministrativeStatus 0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
... InitiatorOnly S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
... org-businesskey S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey
... org-managing-org S0..1Reference(Sequoia Organization)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (required)
... StateOfOperation S0..*AddressExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
... UseCases S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
... identifier:CCN S0..1IdentifierCMS Certification Number (CCN)
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.336
... identifier:HCID S1..1IdentifierOID (such as a Home Community ID) or UUID
Required Pattern: At least the following
.... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: HCID
.... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
... active S1..1booleanWhether the organization's record is still in active use
... Slices for type S1..*CodeableConceptKind of organization
Slice: Unordered, Open by pattern:$this
.... type:sequoiaorgtype S1..1CodeableConceptKind of organization
Binding: Organization Type (required)
.... type:hl7orgrole S0..*CodeableConceptKind of organization
Binding: OrganizationAffiliationRole (required)
... name S1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom S0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:phone S0..*ContactPointA contact detail for the organization
..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
.... telecom:email S0..*ContactPointA contact detail for the organization
..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
... address S0..*AddressAn address for the organization
.... OrgLocation S0..*Reference(Sequoia Location)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
.... line S0..1stringStreet name, number, direction & P.O. Box etc.
.... city S0..1stringName of city, town etc.
.... state S0..1stringSub-unit of country (abbreviations ok)
.... postalCode S0..1stringUS Zip Codes
.... country S0..1stringMust be an ISO 3166 3 letter code
... partOf S0..1Reference(Sequoia Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... company S0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
.... Slices for telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system S0..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
..... telecom:email S0..1ContactPointContact details (telephone, email, etc.) for a contact
...... system S0..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
.... address S0..1AddressVisiting or postal addresses for the contact
..... line S0..1stringStreet name, number, direction & P.O. Box etc.
... endpoint S0..*Reference(Sequoia Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organization.type:sequoiaorgtyperequiredOrganizationType
Organization.type:hl7orgrolerequiredOrganizationAffiliationRole

Constraints

IdGradePath(s)DetailsRequirements
so-1warningOrganizationFor any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileThis is an abstract profile.
A grouping of people or organizations with a common purpose
so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Domains S1..*CodingDomains
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
... HubServiceSubscriptions 0..*CodingHubServiceSubscription
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
... HubRoutingStatus 0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
... InitiatorOnly S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
... org-businesskey S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey
... org-managing-org S0..1Reference(Sequoia Organization)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (required)
... StateOfOperation S0..*AddressExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
... UseCases S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... identifier:CLIA ΣC0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
.... identifier:CCN SΣC0..1IdentifierCMS Certification Number (CCN)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.336
.... identifier:HCID SΣC1..1IdentifierOID (such as a Home Community ID) or UUID

Required Pattern: At least the following
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HCID
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... Slices for type SΣ1..*CodeableConceptKind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.


.... type:sequoiaorgtype SΣ1..1CodeableConceptKind of organization
Binding: Organization Type (required)
.... type:hl7orgrole SΣ0..*CodeableConceptKind of organization
Binding: OrganizationAffiliationRole (required)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... telecom:phone SC0..*ContactPointA contact detail for the organization
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... telecom:email SC0..*ContactPointA contact detail for the organization
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... address SC0..*AddressAn address for the organization
.... OrgLocation S0..*Reference(Sequoia Location)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..1stringStreet 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Σ0..1stringName of city, town etc.
Example General: Erewhon
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringMust be an ISO 3166 3 letter code
... partOf SΣ0..1Reference(Sequoia Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... company S0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... Slices for telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... telecom:email S0..1ContactPointContact details (telephone, email, etc.) for a contact
...... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... address S0..1AddressVisiting or postal addresses for the contact
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... line SΣ0..1stringStreet 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
... endpoint S0..*Reference(Sequoia Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.typeexampleOrganizationType
Organization.type:sequoiaorgtyperequiredOrganizationType
Organization.type:hl7orgrolerequiredOrganizationAffiliationRole
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.telecom:phone.systemrequiredFixed Value: phone
Organization.telecom:phone.userequiredContactPointUse
Organization.telecom:email.systemrequiredFixed Value: email
Organization.telecom:email.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Organization.contact.telecom:phone.systemrequiredFixed Value: phone
Organization.contact.telecom:phone.userequiredContactPointUse
Organization.contact.telecom:email.systemrequiredFixed Value: email
Organization.contact.telecom:email.userequiredContactPointUse
Organization.contact.address.userequiredAddressUse

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
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()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecom, Organization.telecom:phone, Organization.telecom:emailThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
so-1warningOrganizationFor any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileThis is an abstract profile.
A grouping of people or organizations with a common purpose
so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Domains S1..*CodingDomains
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
... HubServiceSubscriptions 0..*CodingHubServiceSubscription
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
... AdministrativeStatus 0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
... HubRoutingStatus 0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
... InitiatorOnly S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly
Binding: Initiator Only (required)
... org-businesskey S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey
... org-managing-org S0..1Reference(Sequoia Organization)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
... PurposesOfUse S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse
Binding: Purpose Of Use (required)
... StateOfOperation S0..*AddressExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation
... UseCases S0..*CodeableConceptExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases
Binding: Endpoint Use Case Codes (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1idUnique 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 ΣC0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1idUnique 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:CCN SΣC0..1IdentifierCMS Certification Number (CCN)

Required Pattern: At least the following
..... id0..1idUnique 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.336
..... 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:HCID SΣC1..1IdentifierOID (such as a Home Community ID) or UUID

Required Pattern: At least the following
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type1..1CodeableConceptDescription of identifier
Fixed Value: (complex)
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: HCID
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... 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Σ1..1booleanWhether the organization's record is still in active use
... Slices for type SΣ1..*CodeableConceptKind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.


.... type:sequoiaorgtype SΣ1..1CodeableConceptKind of organization
Binding: Organization Type (required)
.... type:hl7orgrole SΣ0..*CodeableConceptKind of organization
Binding: OrganizationAffiliationRole (required)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ0..1stringThe actual contact point details
.....