National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: NDH Exchange Network Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndhEx-Network Version: 1.0.0-ballot
Active as of 2023-07-30 Computable Name: NdhExNetwork

A Network refers to a healthcare provider insurance network. A healthcare provider insurance network is an aggregation of organizations and individuals that deliver a set of services across a geography through health insurance products/plans. In the NDH IG, individuals and organizations are represented as participants in a National Directory Exchange Network through the practitionerRole and National Directory Exchange-organizationAffiliation resources, respectively.

Usage:

Formal Views of Profile Content

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

This structure is derived from NdhNetwork

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*NdhNetworkA grouping of people or organizations with a common purpose
... meta
.... profile 1..1canonical(StructureDefinition)Profiles this resource claims to conform to
... extension 1..*ExtensionExtension
... extension:location S0..*LocationReferenceNDH Location Reference
.... value[x] 1..1Reference(NDH Exchange Location Profile)Value of extension
... extension:verification-status S1..1VerificationStatusNDH Verification Status
... identifier 0..*IdentifierIdentifies this organization across multiple systems
.... extension 1..*ExtensionExtension
.... extension:identifier-status S1..1IdentifierStatusNDH Identifier Status
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... assigner S0..1Reference(NDH Exchange Organization Profile)Organization that issued id (may be just text)
... partOf 1..1Reference(NDH Exchange Organization Profile)The organization that manages this network
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... purpose S0..1CodeableConceptThe type of contact
.... name S0..1HumanNameA name associated with the contact
..... use S0..1codeusual | official | temp | nickname | anonymous | old | maiden
..... text S0..1stringText representation of the full name
..... family S0..1stringFamily name (often called 'Surname')
..... given S0..*stringGiven names (not always 'first'). Includes middle names
..... prefix S0..*stringParts that come before the name
..... suffix S0..*stringParts that come after the name
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... extension:contactpoint-availabletime S0..*ContactPointAvailableTimeNDH Contactpoint Availabletime
..... extension:via-intermediary S0..1ViaIntermediaryNDH Via Intermediary
..... system S0..1codephone | fax | email | pager | url | sms | other
..... value S0..1stringThe actual contact point details
..... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
..... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
... endpoint 0..*Reference(NDH Exchange Endpoint Profile)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*NdhNetworkA grouping of people or organizations with a common purpose
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... location S0..*Reference(NDH Base Location Profile)NDH Location Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference"
.... value[x] S1..1Reference(NDH Exchange Location Profile)Value of extension
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status S1..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... 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:All Slices Content/Rules for all slices
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General: 123456
..... assigner SΣ0..1Reference(NDH Exchange Organization Profile)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
Fixed Value: true
... type SΣ1..1CodeableConceptKind of organization
Binding: Network Type Value Set (required)
... name SΣC1..1stringName used for the organization
... telecom SC0..*ContactPointA contact detail for the organization
.... 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.

... address SC0..*AddressAn address for the organization
.... 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..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Σ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..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... partOf SΣ1..1Reference(NDH Exchange Organization Profile)The organization that manages this network
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose S0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S0..1HumanNameA name associated with the contact
..... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text SΣ0..1stringText representation of the full name
..... family SΣ0..1stringFamily name (often called 'Surname')
..... given SΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... contactpoint-availabletime S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary S0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)NDH Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
..... 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 ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
... endpoint S0..*Reference(NDH Exchange Endpoint Profile)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.identifier.userequiredIdentifierUse
Organization.identifier.typeextensibleIdentifier Type Codes
Organization.typerequiredNetworkTypeVS
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*NdhNetworkA grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained C0..*NdhRestrictionA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... location S0..*Reference(NDH Base Location Profile)NDH Location Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference"
.... value[x] S1..1Reference(NDH Exchange Location Profile)Value of extension
... organization-period S0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status S1..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... 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:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(NDH Exchange Organization Profile)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
Fixed Value: true
... type SΣ1..1CodeableConceptKind of organization
Binding: Network Type Value Set (required)
... name SΣC1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom 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Σ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
... address SC0..*AddressAn address for the organization
.... 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..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Σ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..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"}
... partOf SΣ1..1Reference(NDH Exchange Organization Profile)The organization that manages this network
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose S0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S0..1HumanNameA name associated with the contact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text SΣ0..1stringText representation of the full name
..... family SΣ0..1stringFamily name (often called 'Surname')
..... given SΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contactpoint-availabletime S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary S0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)NDH Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
..... 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 ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint S0..*Reference(NDH Exchange Endpoint Profile)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommonTags
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier.userequiredIdentifierUse
Organization.identifier.typeextensibleIdentifier Type Codes
Organization.typerequiredNetworkTypeVS
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse

Differential View

This structure is derived from NdhNetwork

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*NdhNetworkA grouping of people or organizations with a common purpose
... meta
.... profile 1..1canonical(StructureDefinition)Profiles this resource claims to conform to
... extension 1..*ExtensionExtension
... extension:location S0..*LocationReferenceNDH Location Reference
.... value[x] 1..1Reference(NDH Exchange Location Profile)Value of extension
... extension:verification-status S1..1VerificationStatusNDH Verification Status
... identifier 0..*IdentifierIdentifies this organization across multiple systems
.... extension 1..*ExtensionExtension
.... extension:identifier-status S1..1IdentifierStatusNDH Identifier Status
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... assigner S0..1Reference(NDH Exchange Organization Profile)Organization that issued id (may be just text)
... partOf 1..1Reference(NDH Exchange Organization Profile)The organization that manages this network
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... purpose S0..1CodeableConceptThe type of contact
.... name S0..1HumanNameA name associated with the contact
..... use S0..1codeusual | official | temp | nickname | anonymous | old | maiden
..... text S0..1stringText representation of the full name
..... family S0..1stringFamily name (often called 'Surname')
..... given S0..*stringGiven names (not always 'first'). Includes middle names
..... prefix S0..*stringParts that come before the name
..... suffix S0..*stringParts that come after the name
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... extension:contactpoint-availabletime S0..*ContactPointAvailableTimeNDH Contactpoint Availabletime
..... extension:via-intermediary S0..1ViaIntermediaryNDH Via Intermediary
..... system S0..1codephone | fax | email | pager | url | sms | other
..... value S0..1stringThe actual contact point details
..... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
..... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
... endpoint 0..*Reference(NDH Exchange Endpoint Profile)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*NdhNetworkA grouping of people or organizations with a common purpose
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... location S0..*Reference(NDH Base Location Profile)NDH Location Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference"
.... value[x] S1..1Reference(NDH Exchange Location Profile)Value of extension
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status S1..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... 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:All Slices Content/Rules for all slices
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General: 123456
..... assigner SΣ0..1Reference(NDH Exchange Organization Profile)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
Fixed Value: true
... type SΣ1..1CodeableConceptKind of organization
Binding: Network Type Value Set (required)
... name SΣC1..1stringName used for the organization
... telecom SC0..*ContactPointA contact detail for the organization
.... 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.

... address SC0..*AddressAn address for the organization
.... 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..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Σ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..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... partOf SΣ1..1Reference(NDH Exchange Organization Profile)The organization that manages this network
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose S0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S0..1HumanNameA name associated with the contact
..... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text SΣ0..1stringText representation of the full name
..... family SΣ0..1stringFamily name (often called 'Surname')
..... given SΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... contactpoint-availabletime S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary S0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)NDH Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
..... 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 ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
... endpoint S0..*Reference(NDH Exchange Endpoint Profile)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.identifier.userequiredIdentifierUse
Organization.identifier.typeextensibleIdentifier Type Codes
Organization.typerequiredNetworkTypeVS
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*NdhNetworkA grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained C0..*NdhRestrictionA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... location S0..*Reference(NDH Base Location Profile)NDH Location Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference"
.... value[x] S1..1Reference(NDH Exchange Location Profile)Value of extension
... organization-period S0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... verification-status S1..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... 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:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(NDH Exchange Organization Profile)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
Fixed Value: true
... type SΣ1..1CodeableConceptKind of organization
Binding: Network Type Value Set (required)
... name SΣC1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom 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Σ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
... address SC0..*AddressAn address for the organization
.... 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..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Σ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..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"}
... partOf SΣ1..1Reference(NDH Exchange Organization Profile)The organization that manages this network
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose S0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S0..1HumanNameA name associated with the contact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text SΣ0..1stringText representation of the full name
..... family SΣ0..1stringFamily name (often called 'Surname')
..... given SΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom S0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contactpoint-availabletime S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary S0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)NDH Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
..... 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 ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint S0..*Reference(NDH Exchange Endpoint Profile)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommonTags
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier.userequiredIdentifierUse
Organization.identifier.typeextensibleIdentifier Type Codes
Organization.typerequiredNetworkTypeVS
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse

 

Other representations of profile: CSV, Excel, Schematron