SD.6 StructureDefinition-template-profile-on-profile2
template-profile-on-profile2-intro.md file
This is the introduction markdown file that gets inserted into the sd.html template.
This profile sets minimum expectations for blah blah blah
##### Mandatory Data Elements and Terminology
The following data-elements are mandatory (i.e data MUST be present). blah blah blah
**must have:**
1. blah
1. blah
1. blah
**Additional Profile specific implementation guidance:**
#### Examples
SD.6.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://www.fhir.org/guides/sampler2/StructureDefinition/template-profile-on-profile2
Published on Wed Feb 15 00:00:00 PST 2017 as a draft by .
This profile builds on US Core Patient Profile
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Template-Profile-on-Profile | ||
identifier | S | 1..1 | Identifier | |
system | S | 1..1 | uri | Fixed Value: http://Healthedata1/IG-Template/patient-ids |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | I | 0..* | Template-Profile-on-Profile | |
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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
us-core-race | S | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
us-core-ethnicity | S | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
us-core-birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: US Core Birth Sex Value Set (required) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..1 | Identifier | An identifier for this patient |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://Healthedata1/IG-Template/patient-ids |
value | SΣ | 1..1 | string | The value that is unique within the system. Example General': 123456 |
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 | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
name | SΣ | 1..* | HumanName | A name associated with the patient |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
text | Σ | 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 | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
period | Σ | 0..1 | Period | Time period when name was/is in use |
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual |
gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | SΣ | 0..1 | date | The date of birth for the individual |
deceased[x] | ?!Σ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
address | Σ | 0..* | Address | Addresses for the individual |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) | |
multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |
photo | 0..* | Attachment | Image of the patient | |
contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
relationship | 0..* | CodeableConcept | The kind of relationship Binding: v2 Contact Role (extensible) | |
name | 0..1 | HumanName | A name associated with the contact person | |
telecom | 0..* | ContactPoint | A contact detail for the person | |
address | 0..1 | Address | Address for the contact person | |
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
communication | SI | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | 0..* | Reference(Organization), Reference(Practitioner) | Patient's nominated primary care provider | |
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
link | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
other | Σ | 1..1 | Reference(Patient), Reference(RelatedPerson) | The other patient or related person resource that the link refers to |
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required) |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
SD.6.2 Quick Start
Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.
template-profile-on-profile2-search.md file
This is the search markdown file that gets inserted into the sd.html Quick Start section for explanation of the search requirements.