This profile sets minimum expectations for searching for and fetching information associated with a healthcare provider insurance network. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the Organization resource when using this profile.

Background & Scope

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. A network is typically owned by a payer.

In the VHDir IG, individuals and organizations are represented as participants in a Network through the practitionerRole and organizationAffiliation resources, respectively.

Network is a profile on the Organization resource. This profile modifies the base Organization resource in the following manner:

• Constrains the cardinality of organization.active (1..1), organization.telecom (0..0), organization.partOf (1..1), organization.contact.name.family (1..1), organization.contact.name.given (1..*), organization.contact.telecom.system (1..1), and organization.contact.telecom.value (1..1)

• All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile

• Adds extensions:

1. Identifier status (1..1) - indicates the status of an organization's identifier
2. Via intermediary (0..1) - a reference to an alternative point of contact for this organization
3. Available time (0..*) - indicates when an organization is available for contact
4. Period (0..1) - Represents a time period for the network
5. Coverage area (0..*) - Indicates a coverage area for the network
6. Restriction (0..*) - indicates whether disclosure of any data associated with a network is restricted

Examples:

The following are example uses for the vhdir-network profile:

• Patriot Preferred Provider Network
• Patriot Dental Provider Network

Mandatory Data Elements

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each network must have:

1. A coded value in organization.active
2. A reference to an organization or organizationaffiliation resource indicating the owner of the network in organization.partOf

Profile specific implementation guidance:

• PractitionerRole and OrganizationAffiliation are used to indicate a Practitioner and Organization's participation in a Network, respectively

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	Organization	Network dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
timePeriod	S	0..1	Period	Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
coverageArea	S	0..*	Reference(VhDir Location)	Network coverage area URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣC	0..*	Identifier	Identifies this network across multiple systems ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	SΣ	0..1	CodeableConcept	Description 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. ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children
assigner	SΣ	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
active	?!SΣ	1..1	boolean	Whether the network's record is still in active use. ele-1: All FHIR elements must have a @value or children
type	SΣ	0..*	CodeableConcept	Type of network Binding: VhDir Network Type Value Set (example) ele-1: All FHIR elements must have a @value or children
name	SΣC	0..1	string	Name ele-1: All FHIR elements must have a @value or children
alias	S	0..*	string	Alternate names by which the Network is known ele-1: All FHIR elements must have a @value or children
address	SC	0..*	Address	An address for the network ele-1: All FHIR elements must have a @value or children org-2: An address of an organization can never be of use 'home'
partOf	SΣ	1..1	Reference(VhDir Organization)	Reference to organization that owns the network ele-1: All FHIR elements must have a @value or children
contact	S	0..*	BackboneElement	Contact for the network for a certain purpose. ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
purpose	S	0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. ele-1: All FHIR elements must have a @value or children
name	S	0..1	HumanName	A name associated with the contact ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Text representation of the full name ele-1: All FHIR elements must have a @value or children
family	SΣ	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name ele-1: All FHIR elements must have a @value or children This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name ele-1: All FHIR elements must have a @value or children This repeating element order: Suffixes appear in the correct order for presenting the name
period	SΣ	0..1	Period	Time period when name was/is in use ele-1: All FHIR elements must have a @value or children
telecom	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
viaintermediary	S	0..1	Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)	viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children
period	SΣ	0..1	Period	Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children
address	S	0..1	Address	Visiting or postal addresses for the contact ele-1: All FHIR elements must have a @value or children
endpoint	S	0..*	Reference(VhDir Endpoint)	Technical endpoints providing access to services operated for the network ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.type	example	VhDirNetworkType (a valid code from VhDir Network Type Code System) http://hl7.org/fhir/uv/vhdir/ValueSet/network-type from this IG
Organization.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard
Organization.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Organization.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Organization.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard

This structure is derived from Organization

Name	Flags	Card.	Type	Description & Constraints
Organization		0..*	Organization	Network
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
timePeriod	S	0..1	Period	Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period
coverageArea	S	0..*	Reference(VhDir Location)	Network coverage area URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
identifier	S	0..*	Identifier	Identifies this network across multiple systems
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required)
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
period	S	0..1	Period	Time period when id is/was valid for use
assigner	S	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text)
active	S	1..1	boolean	Whether the network's record is still in active use.
type	S	0..*	CodeableConcept	Type of network Binding: VhDir Network Type Value Set (example)
name	S	0..1	string	Name
alias	S	0..*	string	Alternate names by which the Network is known
telecom	S	0..0
address	S	0..*	Address	An address for the network
partOf	S	1..1	Reference(VhDir Organization)	Reference to organization that owns the network
contact	S	0..*	BackboneElement	Contact for the network for a certain purpose.
purpose	S	0..1	CodeableConcept	The type of contact
name	S	0..1	HumanName	A name associated with the contact
use	S	0..1	code	usual | official | temp | nickname | anonymous | old | maiden
text	S	0..1	string	Text representation of the full name
family	S	1..1	string	Family name (often called 'Surname')
given	S	1..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..*	string	Parts that come before the name
suffix	S	0..*	string	Parts that come after the name
period	S	0..1	Period	Time period when name was/is in use
telecom	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
viaintermediary	S	0..1	Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)	viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
rank	S	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	S	0..1	Period	Time period when the contact point was/is in use
address	S	0..1	Address	Visiting or postal addresses for the contact
endpoint	S	0..*	Reference(VhDir Endpoint)	Technical endpoints providing access to services operated for the network
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.type	example	VhDirNetworkType (a valid code from VhDir Network Type Code System) http://hl7.org/fhir/uv/vhdir/ValueSet/network-type from this IG

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	Organization	Network org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
timePeriod	S	0..1	Period	Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period
coverageArea	S	0..*	Reference(VhDir Location)	Network coverage area URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣC	0..*	Identifier	Identifies this network across multiple systems
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description 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..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether the network's record is still in active use.
type	SΣ	0..*	CodeableConcept	Type of network Binding: VhDir Network Type Value Set (example)
name	SΣC	0..1	string	Name
alias	S	0..*	string	Alternate names by which the Network is known
address	SC	0..*	Address	An address for the network org-2: An address of an organization can never be of use 'home'
partOf	SΣ	1..1	Reference(VhDir Organization)	Reference to organization that owns the network
contact	S	0..*	BackboneElement	Contact for the network for a certain purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose	S	0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name	S	0..1	HumanName	A name associated with the contact
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	0..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	string	Given 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..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	SΣ	0..1	Period	Time period when name was/is in use
telecom	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
viaintermediary	S	0..1	Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)	viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	SΣ	0..1	Period	Time period when the contact point was/is in use
address	S	0..1	Address	Visiting or postal addresses for the contact
endpoint	S	0..*	Reference(VhDir Endpoint)	Technical endpoints providing access to services operated for the network
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.type	example	VhDirNetworkType (a valid code from VhDir Network Type Code System) http://hl7.org/fhir/uv/vhdir/ValueSet/network-type from this IG
Organization.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard
Organization.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Organization.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Organization.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	Organization	Network dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
timePeriod	S	0..1	Period	Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
coverageArea	S	0..*	Reference(VhDir Location)	Network coverage area URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣC	0..*	Identifier	Identifies this network across multiple systems ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	SΣ	0..1	CodeableConcept	Description 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. ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children
assigner	SΣ	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
active	?!SΣ	1..1	boolean	Whether the network's record is still in active use. ele-1: All FHIR elements must have a @value or children
type	SΣ	0..*	CodeableConcept	Type of network Binding: VhDir Network Type Value Set (example) ele-1: All FHIR elements must have a @value or children
name	SΣC	0..1	string	Name ele-1: All FHIR elements must have a @value or children
alias	S	0..*	string	Alternate names by which the Network is known ele-1: All FHIR elements must have a @value or children
address	SC	0..*	Address	An address for the network ele-1: All FHIR elements must have a @value or children org-2: An address of an organization can never be of use 'home'
partOf	SΣ	1..1	Reference(VhDir Organization)	Reference to organization that owns the network ele-1: All FHIR elements must have a @value or children
contact	S	0..*	BackboneElement	Contact for the network for a certain purpose. ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
purpose	S	0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. ele-1: All FHIR elements must have a @value or children
name	S	0..1	HumanName	A name associated with the contact ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
text	SΣ	0..1	string	Text representation of the full name ele-1: All FHIR elements must have a @value or children
family	SΣ	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name ele-1: All FHIR elements must have a @value or children This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name ele-1: All FHIR elements must have a @value or children This repeating element order: Suffixes appear in the correct order for presenting the name
period	SΣ	0..1	Period	Time period when name was/is in use ele-1: All FHIR elements must have a @value or children
telecom	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
viaintermediary	S	0..1	Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)	viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children
period	SΣ	0..1	Period	Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children
address	S	0..1	Address	Visiting or postal addresses for the contact ele-1: All FHIR elements must have a @value or children
endpoint	S	0..*	Reference(VhDir Endpoint)	Technical endpoints providing access to services operated for the network ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.type	example	VhDirNetworkType (a valid code from VhDir Network Type Code System) http://hl7.org/fhir/uv/vhdir/ValueSet/network-type from this IG
Organization.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard
Organization.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Organization.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Organization.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard

Differential View

This structure is derived from Organization

Name	Flags	Card.	Type	Description & Constraints
Organization		0..*	Organization	Network
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
timePeriod	S	0..1	Period	Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period
coverageArea	S	0..*	Reference(VhDir Location)	Network coverage area URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
identifier	S	0..*	Identifier	Identifies this network across multiple systems
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required)
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
period	S	0..1	Period	Time period when id is/was valid for use
assigner	S	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text)
active	S	1..1	boolean	Whether the network's record is still in active use.
type	S	0..*	CodeableConcept	Type of network Binding: VhDir Network Type Value Set (example)
name	S	0..1	string	Name
alias	S	0..*	string	Alternate names by which the Network is known
telecom	S	0..0
address	S	0..*	Address	An address for the network
partOf	S	1..1	Reference(VhDir Organization)	Reference to organization that owns the network
contact	S	0..*	BackboneElement	Contact for the network for a certain purpose.
purpose	S	0..1	CodeableConcept	The type of contact
name	S	0..1	HumanName	A name associated with the contact
use	S	0..1	code	usual | official | temp | nickname | anonymous | old | maiden
text	S	0..1	string	Text representation of the full name
family	S	1..1	string	Family name (often called 'Surname')
given	S	1..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..*	string	Parts that come before the name
suffix	S	0..*	string	Parts that come after the name
period	S	0..1	Period	Time period when name was/is in use
telecom	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
viaintermediary	S	0..1	Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)	viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
system	S	1..1	code	phone | fax | email | pager | url | sms | other
value	S	1..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
rank	S	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	S	0..1	Period	Time period when the contact point was/is in use
address	S	0..1	Address	Visiting or postal addresses for the contact
endpoint	S	0..*	Reference(VhDir Endpoint)	Technical endpoints providing access to services operated for the network
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.type	example	VhDirNetworkType (a valid code from VhDir Network Type Code System) http://hl7.org/fhir/uv/vhdir/ValueSet/network-type from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	Organization	Network org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
timePeriod	S	0..1	Period	Valid time period for this Network URL: http://hl7.org/fhir/StructureDefinition/organization-period
coverageArea	S	0..*	Reference(VhDir Location)	Network coverage area URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣC	0..*	Identifier	Identifies this network across multiple systems
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	CodeableConcept	Description 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..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether the network's record is still in active use.
type	SΣ	0..*	CodeableConcept	Type of network Binding: VhDir Network Type Value Set (example)
name	SΣC	0..1	string	Name
alias	S	0..*	string	Alternate names by which the Network is known
address	SC	0..*	Address	An address for the network org-2: An address of an organization can never be of use 'home'
partOf	SΣ	1..1	Reference(VhDir Organization)	Reference to organization that owns the network
contact	S	0..*	BackboneElement	Contact for the network for a certain purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose	S	0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name	S	0..1	HumanName	A name associated with the contact
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	0..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	string	Given 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..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	SΣ	0..1	Period	Time period when name was/is in use
telecom	S	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
viaintermediary	S	0..1	Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)	viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	SΣ	0..1	Period	Time period when the contact point was/is in use
address	S	0..1	Address	Visiting or postal addresses for the contact
endpoint	S	0..*	Reference(VhDir Endpoint)	Technical endpoints providing access to services operated for the network
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Organization.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.type	example	VhDirNetworkType (a valid code from VhDir Network Type Code System) http://hl7.org/fhir/uv/vhdir/ValueSet/network-type from this IG
Organization.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard
Organization.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Organization.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Organization.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard

This structure is derived from Organization

Summary

Mandatory: 2 elements(6 nested mandatory elements)
Must-Support: 38 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• VhDir Organization (http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organization)
• VhDir Endpoint (http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-endpoint)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/organization-period
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/location-reference
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary

Maturity: 2

Supported Searches

1. GET [base]/Organization?active=[code]

   Support: SHALL support search by the active parameter: http://hl7.org/fhir/SearchParameter/Organization-active

1. GET [base]/Organization?address-use=[code]

   Support: MAY support search by the address-use parameter: http://hl7.org/fhir/SearchParameter/Organization-address-use

1. GET [base]/Organization?coverage-area=[id]

   Support: SHOULD support search by the network's coverage-area parameter

   • with a target type: Location
   • including these search paramaters which may be chained: coverage-area.identifier, coverage-area.contains

1. GET [base]/Organization?address=[string]

   Support: SHALL support search by the address parameter

   • including the modifiers: contains, exact

1. GET [base]/Organization?address-city=[string]

   Support: SHOULD support search by the address-city parameter

   • including the modifiers: exact

1. GET [base]/Organization?address-country=[string]

   Support: SHOULD support search by the address-country parameter

   • including the modifiers: exact

1. GET [base]/Organization?address-postalcode=[string]

   Support: SHOULD support search by the address-postalcode parameter

   • including the modifiers: exact

1. GET [base]/Organization?address-state=[string]

   Support: SHOULD support search by the address-state parameter

   • including the modifiers: exact

1. GET [base]/Organization?endpoint=[id]

   Support: SHALL support search by the endpoint parameter

   • with a target type: Endpoint
   • including these search paramaters which may be chained: endpoint.identifier, endpoint.connection-type, endpoint.organization

1. GET [base]/Organization?identifier=[code]

   Support: SHALL support search by the identifier parameter

   • including the modifiers: text, ofType

1. GET [base]/Organization?identifier-assigner=[id]

   Support: MAY support search by the identifier-assigner parameter

   • with a target type: Organization
   • including the modifiers: below
   • including these search paramaters which may be chained: identifier-assigner.identifier, identifier-assigner.name

1. GET [base]/Organization?name=[string]

   Support: SHALL support search by the name parameter

   • including the modifiers: exact, contains

1. GET [base]/Organization?partof=[id]

   Support: SHALL support search by the partof parameter

   • with a target type: Organization
   • including the modifiers: above, below
   • including these search paramaters which may be chained: partof.identifier, partof.name, partof.address, partof.type