National Healthcare Directory Query
1.0.0-ballot - ballot US

This page is part of the National Healthcare Query (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Extension: NewPatients - Detailed Descriptions

Active as of 2022-08-09

Definitions for the newpatients extension.

1. Extension
Definition

New Patients indicates whether new patients are being accepted in general, or from a specific network.
This extension is included in the PractitionerRole, HealthcareService, and Location profiles.
This provides needed flexibility for specifying whether a provider accepts new patients by location and network.

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
new-patients-characteristics: If no new patients are accepted, no characteristics are allowed (: extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty())
2. Extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
3. Extension.extension
Definition

An Extension

Control1..*
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Extension.extension:acceptingPatients
SliceNameacceptingPatients
Definition

An Extension

Control1..1
TypeExtension
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
5. Extension.extension:acceptingPatients.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
6. Extension.extension:acceptingPatients.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
7. Extension.extension:acceptingPatients.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueacceptingPatients
8. Extension.extension:acceptingPatients.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control1..1
BindingThe codes SHALL be taken from Accepting Patients Codes Value Set
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Extension.extension:fromNetwork
SliceNamefromNetwork
Definition

An Extension

Control0..1
TypeExtension
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Extension.extension:fromNetwork.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
11. Extension.extension:fromNetwork.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
12. Extension.extension:fromNetwork.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValuefromNetwork
13. Extension.extension:fromNetwork.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control1..1
TypeReference(NatlDirEndpointQryNetwork)
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Extension.extension:characteristics
SliceNamecharacteristics
Definition

An Extension

Control0..*
TypeExtension
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. Extension.extension:characteristics.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
16. Extension.extension:characteristics.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
17. Extension.extension:characteristics.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuecharacteristics
18. Extension.extension:characteristics.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control1..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
20. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))