HL7.FHIR.US.VRDR\Interested Party

Vital Records Death Reporting FHIR Implementation Guide
1.2.0 - STU 2 Ballot

This page is part of the Vital Records Mortality and Morbidity Reporting FHIR IG (v1.2.0: STU 2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Interested Party

Defining URL:

http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Interested-Party

Version:

1.2.0

Name:

InterestedParty

Title:

VRDR Interested Party

Status:

Draft as of 2021-08-13T12:59:07+00:00

Publisher:

Health Level Seven International

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Interested-Party

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 5 elements

Structures

This structure refers to these other structures:

http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Interested-Party

This structure is derived from USCoreOrganizationProfile

Name	Card.	Type	Description & Constraints
Organization	0..*	USCoreOrganizationProfile	A grouping of people or organizations with a common purpose
id	0..1	string	id
identifier	1..1	Identifier	identifier
active	1..1	boolean	active
type	1..1	CodeableConcept	type Binding: OrganizationType (required)
name	1..1	string	name
address	1..1	Address	address
partOf	0..1	Reference(VRDR Interested Party)	partOf
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Organization	I	0..*	USCoreOrganizationProfile	A grouping of people or organizations with a common purpose
id	Σ	0..1	string	id
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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣI	1..1	Identifier	identifier Slice: Unordered, Open by pattern:$this
identifier:NPI	SΣI	0..1	Identifier	National Provider Identifier (NPI) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:CLIA	SΣI	0..1	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	active
type	Σ	1..1	CodeableConcept	type Binding: OrganizationType (required)
name	SΣI	1..1	string	name
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SI	0..*	ContactPoint	A contact detail for the organization
address	SI	1..1	Address	address
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..4	string	Street 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..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
partOf	Σ	0..1	Reference(VRDR Interested Party)	partOf
contact		0..*	BackboneElement	Contact for the organization 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		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Organization	I	0..*	USCoreOrganizationProfile	A grouping of people or organizations with a common purpose
Slices for identifier	ΣI	1..1	Identifier	identifier Slice: Unordered, Open by pattern:$this
identifier:NPI	ΣI	0..1	Identifier	National Provider Identifier (NPI) Required Pattern: At least the following
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
identifier:CLIA	ΣI	0..1	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
active	?!Σ	1..1	boolean	active
name	ΣI	1..1	string	name
telecom	I	0..*	ContactPoint	A contact detail for the organization
address	I	1..1	Address	address
line	Σ	0..4	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label
city	Σ	0..1	string	Name of city, town etc.
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode	Σ	0..1	string	US Zip Codes
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 5 elements

Structures

This structure refers to these other structures:

http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Interested-Party

Differential View

This structure is derived from USCoreOrganizationProfile

Name	Card.	Type	Description & Constraints
Organization	0..*	USCoreOrganizationProfile	A grouping of people or organizations with a common purpose
id	0..1	string	id
identifier	1..1	Identifier	identifier
active	1..1	boolean	active
type	1..1	CodeableConcept	type Binding: OrganizationType (required)
name	1..1	string	name
address	1..1	Address	address
partOf	0..1	Reference(VRDR Interested Party)	partOf
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Organization	I	0..*	USCoreOrganizationProfile	A grouping of people or organizations with a common purpose
id	Σ	0..1	string	id
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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣI	1..1	Identifier	identifier Slice: Unordered, Open by pattern:$this
identifier:NPI	SΣI	0..1	Identifier	National Provider Identifier (NPI) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:CLIA	SΣI	0..1	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	active
type	Σ	1..1	CodeableConcept	type Binding: OrganizationType (required)
name	SΣI	1..1	string	name
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SI	0..*	ContactPoint	A contact detail for the organization
address	SI	1..1	Address	address
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..4	string	Street 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..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
partOf	Σ	0..1	Reference(VRDR Interested Party)	partOf
contact		0..*	BackboneElement	Contact for the organization 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		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
Organization.language	preferred	CommonLanguages Max Binding: AllLanguages
Organization.type	required	OrganizationType
Organization.address.use	required	AddressUse
Organization.address.type	required	AddressType
Organization.address.state	extensible	UspsTwoLetterAlphabeticCodes
Organization.contact.purpose	extensible	ContactEntityType

Constraints

Id	Path	Details	Requirements
dom-2	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	Organization	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 : 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-4	Organization	If 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-5	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Organization	A resource should have narrative for robust management : text.`div`.exists()
org-1	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
ele-1	Organization.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Organization.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Organization.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Organization.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Organization.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.identifier:NPI	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.identifier:CLIA	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.active	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.alias	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
org-3	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()
ele-1	Organization.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
org-2	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
ele-1	Organization.address.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Organization.address.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Organization.address.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.line	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.city	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.district	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.state	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.postalCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.country	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.partOf	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.contact	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.contact.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Organization.contact.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Organization.contact.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Organization.contact.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Organization.contact.purpose	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.contact.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.contact.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.contact.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.endpoint	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())