SD.2 StructureDefinition-template-profile-on-profile
Template-Profile-on-Profile.md file
Conformance resource variables defined here
id = template-profile-on-profile
- index : a local id for the structure: {{site.data.structuredefinitions.[id].index}} = 1
- url : full canonical url for the structure: {{site.data.structuredefinitions.[id].url}} = http://www.fhir.org/guides/sampler2/StructureDefinition/template-profile-on-profile
- name : the name given for it: {{site.data.structuredefinitions.[id].name}} = Template-Profile-on-Profile
- path : the path to it in the built html: {{site.data.structuredefinitions.[id].path}} = StructureDefinition-template-profile-on-profile.html
- kind : the kind (complex data type, resource, logical model): {{site.data.structuredefinitions.[id].kind}} = resource
- type : the base type: {{site.data.structuredefinitions.[id].type}} = Patient
- base : the url for structure definition from which it derives: {{site.data.structuredefinitions.[id].base}} = http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
- basename : the name of the structure definition from which it derives: {{site.data.structuredefinitions.[id].basename}} = US Core Patient Profile
- basepath : the url to the structure definition from which it derives: {{site.data.structuredefinitions.[id].basepath}} = http://build.fhir.org/ig/HL7/US-Core//StructureDefinition-us-core-patient.html
- status : the status (draft, active, retired): {{site.data.structuredefinitions.[id].status}} = draft
- date : the date in the resource: {{site.data.structuredefinitions.[id].date}} = Wed Feb 15 00:00:00 PST 2017
- publisher : the stated publisher: {{site.data.structuredefinitions.[id].publisher}} =
- copyright : the stated copyright for the resource: {{site.data.structuredefinitions.[id].copyright}} =
- description : the description for the resource: {{site.data.structuredefinitions.[id].description}} =
- contextType : the type of context associated with an extension structure definition: {{site.data.structuredefinitions.[id].contextType}} =
- contexts : an array of paths for each allowed context path for an extension: {{site.data.structuredefinitions.[id].contexts}} =
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:
- blah
- blah
- blah
Additional Profile specific implementation guidance:
Examples
SD.2.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-profile
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.2.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-profile-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.
GET /profile-on-profile?patient={id}
Example:
[example here]
Support: e.g. Mandatory for client to support search by patient. Optional for server to support.
Implementation Notes: blah blah blah
Response Class:
- (Status 200): successful operation
- (Status 400): invalid parameter
- (Status 401/4xx): unauthorized request
- (Status 403): insufficient scope
